Install Vnecoms Magento 2 Extensions Using Composer

This topic explains how to install extensions you purchase from the Vnecoms website using the Composer - a dependency manager for PHP, Composer declare the libraries your project depends on and it will manage (install/update) them for you so it is very useful if you have so many libraries or modules. You can use the same procedure to install any extension.

To install an extension, you must:

1. Get an access key.
2. Load composer packages.
3. Verify that the extension installed properly.
4. Enable and configure the extension.

1. GET AN ACCESS KEY

Firstly, you will need an access key to access to VNECOMS's composer. Login to your customer email account at vnecoms.com. In My Account page, click to Access Key in left navigation bar. You can also just click to this link https://www.vnecoms.com/access-keys/.

Click to Create a new Access Key to start adding new access key.

After you get the access key, visit to vnecoms repo page: https://repo.vnecoms.com You will be asked for login. Use your access key which you have just created to login with user name is the public key and password is private key

2. LOAD COMPOSER PACKAGE

After logging in the Vnecoms repository page, you will be able to see the composer command to install your purchased extension along with extension's composer name and version.

2.1 Update composer.json file

{
  "repositories": [
    {
      "type": "composer",
      "url": "https://repo.vnecoms.com"
    }
  ]
}

$ composer config repositories.vnecoms-repo composer https://repo.vnecoms.com

2.2 Update a auth.json file

$ composer config http-basic.repo.magento.com username password

$ composer config --global http-basic.repo.magento.com username password

$ composer config http-basic.repo.vnecoms.com username password

2.3 Load a composer package

$ composer require <component-name>:<version>

$ composer require vnecoms/module-core:2.0.0

3. VERIFY THE EXTENSION

To verify that the extension installed properly, run the following command:

$ bin/magento module:status

By default, the extension is probably disabled:

List of disabled modules:
Vnecoms_Core

The extension name is in the format <VendorName>_<ComponentName>;

4. ENABLE EXTENSION

Some extensions won’t work properly unless you clear Magento-generated static view files first. Use the --clear-static-content option to clear static view files when you’re enabling an extension.

1. Enable the extension and clear static view files:

   $ bin/magento module:enable Vnecoms_Core --clear-static-content
   

   You should see the following output:

   The following modules have been enabled:
   - Vnecoms_Core
   
   To make sure that the enabled modules are properly registered, run 'setup:upgrade'.
   Cache cleared successfully.
   Generated classes cleared successfully. Please run the 'setup:di:compile' command to generate classes.
   Generated static view files cleared successfully.
   

2. Register the extension:

   $ bin/magento setup:upgrade
   

3. Recompile your Magento project:

   In Production mode, you may receive a message to 'Please rerun Magento compile command'.  Enter the command below. Magento does not prompt you to run the compile command in Developer mode.
   
   $ bin/magento setup:di:compile
   

4. Verify that the extension is enabled:

   $ bin/magento module:status
   

   You should see output verifying that the extension is no longer disabled:

   List of enabled modules:
   Vnecoms_Core
   
   List of disabled modules:
   None
   

5. Clean the cache:

   $ bin/magento cache:clean
   

6. Configure the extension in Admin as needed.

If you encounter errors when loading the storefront in a browser, use the following command to clear the cache:
bin/magento cache:flush

5. UPDATE EXTENSION INSTALLED BY COMPOSER

1. Change to developer mode (if you are already in production mode)

   php bin/magento deploy:mode:set developer

2. Check module outdated

   composer outdated <package-name>

   Example: composer outdated vnecoms/marketplace-standard

3. Require to higher verion

   composer require --no-update <package-name>:<new-higer-version> 

   OR

   composer update vnecoms/* 

   OR

   composer require --no-update <package-name> 2.x.x 

   Example: composer require --no-update vnecoms/marketplace-standard:2.3.1

   Example: composer require --no-update vnecoms/marketplace-standard ^2.x.x

   command use caret range updates (^) only the last two version numbers: e.g. ^2.x.x ( only x.x will be updated).

4. Run setup upgrade

   php bin/magento setup:upgrade 

5. Re-enable back to production mode (if you switch production to developer mode before)

   php bin/magento deploy:mode:set production

6. Re-compile if you are in production mode (Ignore this step if you are in developer mode)

   php bin/magento setup:di:compile
   php bin/magento setup:static-content:deploy <locale_used>

7. Clear caches

   php bin/magento cache:flush

6. REMOVE EXTENSION INSTALLED BY COMPOSER

1. Disable module first

   php bin/magento module:disable <VendorName>_<ComponentName>

2. Run setup upgrade

   php bin/magento setup:upgrade

3. Remove module

   composer remove <package-name> --no-update

   Example: composer remove vnecoms/marketplace-standard --no-update

4. Clear caches

   php bin/magento cache:flush