Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.98 KB

README.md

File metadata and controls

57 lines (39 loc) · 2.98 KB
Raw

Stockbase Magento 2 Module

For information and features please visit the online documentation or refer to the docs folder.

Build Status Code Coverage Scrutinizer Code Quality Packagist Packagist

Installation

Requirements

  • Magento 2.
  • A running Magento cron (official how-to).
  • A Stockbase username and password with suppliers connected to your account.

Install with Composer

This is the recommended way to install the module for Magento 2. This method allows you to automatically download the module and all its dependencies with a single console command.

  1. Make sure you have Composer installed.
  2. Navigate to your Magento 2 installation directory (where your composer.json and composer.lock files are located).
  3. Execute the command: composer require stockbase/magento2-module

Install Manually

Warning! This installation is method recommended for module development only and we assume that you know how to work with PHP and Composer. If you're not sure whether you need this type of installation, please follow the instructions for Composer installation in Section 1.2.1.

  1. Download the zip archive containing the module.
  2. Extract it into the <magento root folder>/app/code/Stockbase/Integration directory.
  3. Install into your main Magento project all dependencies listed in this module's composer.json file. For example: composer require dividebv/phpdivideiq:^0.5.0 beberlei/assert:^2.4. See the require section of the module's composer.json file.

Enable the Module

Execute the following commands in the Magento installation directory:

php bin/magento module:enable Stockbase_Integration
php bin/magento setup:upgrade

After successful installation, you can configure the module via the admin panel.

License

This module is licensed under the MIT License

Contributing

If you're interested in contributing please read our Contributing Guidelines