recolize/module-recommendation-engine-magento2 dev-master

The Recolize Recommendation Engine as extension for Magento 2

Type

magento2-module

License

GPL-3.0-or-later

Requires
Requires (dev)

None

Suggests

None

Provides

None

Conflicts

None

Replaces

None

Recolize Recommendation Engine for Magento 2

Getting Started

Thank you very much for using our Recolize Recommendation Engine for Magento 2. Please find some installation advices below and more information on https://www.recolize.com.

Prerequisites

Recolize Recommendation Engine is fully compatible with Magento versions starting from 2.0 (Community and Enterprise Editions).

Please note that the Magento cronjob should be set up correctly to use all features of this extension without any limitations (see http://devdocs.magento.com/guides/v2.0/config-guide/cli/config-cli-subcommands-cron.html).

Installation

We recommend to proceed with the following preparational steps before you start the installation of the Recolize Recommendation Engine Extension for Magento 2:

  • For safety reasons please create a backup of your Magento installation in order to be able to reset the system to the current state in case of an emergency
  1. In the root directory of your Magento 2 installation install the Recolize Recommendation Engine Extension via the following composer command:

    composer require recolize/module-recommendation-engine-magento2
    
  2. Afterwards activate the Magento 2 Extension with the following commands:

    bin/magento module:enable Recolize_RecommendationEngine
    bin/magento setup:upgrade
    bin/magento cache:flush
    
  3. Register for free at https://www.recolize.com/en/register, login at https://tool.recolize.com and create a new domain with the product feed url that is displayed in Stores > Configuration > Recolize Recommendation Engine > Recolize Product Feed Settings.

  4. Copy the JavaScript snippet code from the domain configuration into the appropriate Magento setting at Stores > Configuration > Recolize Recommendation Engine.

Installation without Composer (if composer is not available)

  1. Unpack the setup package Recolize_Recommendation_*.zip and upload the unpacked contents into the root directory of your Magento installation (for example via FTP). The folder structure is exactly the same as in your Magento installation (app/code). In case of a fresh module installation no files will be overwritten.

  2. Flush your Magento cache, e.g. in System > Cache Management as well as the JavaScript-/CSS-Cache on the same page.

  3. Register for free at https://www.recolize.com/en/register, login at https://tool.recolize.com and create a new domain with the product feed url that is displayed in Stores > Configuration > Recolize Recommendation Engine > Recolize Product Feed Settings.

  4. Copy the JavaScript snippet code from the domain configuration into the appropriate Magento setting at Stores > Configuration > Recolize Recommendation Engine.

Authors

Recolize GmbH (https://www.recolize.com).

License

This project is licensed under the GPLv3 License - see the LICENSE.txt file for details.

Frequently Asked Questions

I need help with the installation process

For more information regarding the installation of the Magento extension please have a look at our FAQs at https://www.recolize.com/en/faq.

How can I completely disable the extension if I am experiencing any problems?

In case of an emergency you can easily disable the extension temporarily via the configuration setting in Stores > Configuration > Recolize Recommendation Engine > Enable extension. As an alternative you can execute the following command in the Magento root directory:

bin/magento module:disable Recolize_RecommendationEngine