README

The Armanet_Integration module for Magento 2.4 facilitates seamless integration between Magento and Armanet services, enhancing your e-commerce platform's capabilities.

📚 Full documentation: https://developer.armanet.ai/plugins/magento

Installation

1. Install via Composer (Recommended)

Navigate to your Magento root directory, run the following command:

$ composer require armanet/magento-integration

Enable and install the module:

$ php bin/magento module:enable Armanet_Integration
$ php bin/magento setup:upgrade
$ php bin/magento cache:flush

2. Install Manually

Download the module package. Then, extract and upload the contents to:

$ app/code/Armanet/Integration

Enable and install the module:

$ php bin/magento module:enable Armanet_Integration
$ php bin/magento setup:upgrade
$ php bin/magento cache:flush

Configuration

• Log in to your Magento Admin Panel.
• Navigate to Stores > Configuration > Armanet Integration.
• Configure the API settings and other parameters as required.
• Save the configuration and clear the cache:

$ php bin/magento cache:flush

Troubleshooting

If you experience any issues, check Magento logs:

$ tail -f var/log/system.log var/log/exception.log

Run the following command to recompile:

$ php bin/magento setup:di:compile

Uninstallation

To remove the module, run:

$ php bin/magento module:disable Armanet_Integration
$ composer remove armanet/magento-integration
$ php bin/magento setup:upgrade
$ php bin/magento cache:flush

Development

Unit Tests

The module includes comprehensive unit tests that verify individual components' functionality.

To run all unit tests:

$ cd <magento_root>
$ ./vendor/bin/phpunit -c app/code/Armanet/Integration/phpunit.xml.dist

To run specific test files:

$ cd <magento_root>
$ ./vendor/bin/phpunit app/code/Armanet/Integration/Test/Unit/Controller/ProductFeed/IndexTest.php -c app/code/Armanet/Integration/phpunit.xml.dist

Code Style

The module adheres to PSR coding standards, ensuring a consistent and readable codebase.

To check code formatting:

$ cd <magento_root>
$ ./vendor/bin/php-cs-fixer fix --dry-run app/code/Armanet/Integration

To fix code formatting:

$ cd <magento_root>
$ ./vendor/bin/php-cs-fixer fix app/code/Armanet/Integration

License

The Armanet_Integration module is released under the BSD-3-Clause license. For more information, see the LICENSE file.