Magento Installation

Magento module for Katalys integration. This is required only when doing the first installation.

Installation

Step 1

Run the following command to install the package using Composer:

BASH

composer require katalys/magento-bridge-module

If the installation requests the token, click on the link and GitHub will create the token for you; else, continue with the installation process.

Step 2

Enable your module:

BASH

bin/magento module:enable Katalys_Shop

Step 3

Execute the command below:

BASH

bin/magento setup:upgrade

Step 4

Execute the command below to compile the Magento:

BASH

bin/magento setup:di:compile

Step 5

Execute the command below to compile the theme of the Magento:

BASH

bin/magento setup:static-content:deploy

How to Update

To update this module, run the following command:

CODE

composer update katalys/magento-bridge-module

Note that this will also update any other packages in the project according to composer definition. Depending on the nature of the update, the following commands may also be required:

CODE

bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy

Version Rollback

If you experience an error with the newly installed plugin, you can revert to the last version. If you install version 1.0.1 and need to rollback to the last version that worked 1.0.0, reference the example below:

CODE

composer require katalys/magento-bridge-module:1.0.0
bin/magento setup:upgrade
bin/magento setup:static-content:deploy
bin/magento setup:di:compile

If after rolling back to the prior version you experience an error, please send an email describing the issue. In the email, please provide the below information:

Magento version
Module Version
PHP version
Description the error
Step-by-step instructions that led to the error
Screenshots ( and on-screen recording, if possible )

Send the email to techsupport@katalys.com

Removal

Run the following command to remove the package using composer:

CODE

php bin/magento module:disable Katalys_Shop
composer remove katalys/magento-bridge-module
php bin/magento setup:static-content:deploy
php bin/magento setup:di:compile