README

Mastersoft Address Autocomplete extension or module for Magento2.

Releases

v1.0.x is compatible for Magento 2.2 (tested with Magento 2.2.4)
v1.1.x is compatible for Magento 2.3 (tested with Magento 2.3.4 and 2.2.4)

Installation

Go to your Magento2 Home (usually is in /var/www/html directory).

Composer Installation (Recommended)

Make sure git is installed: apt-get install git.

/var/www/html# cp composer.json composer.json.old
composer require mastersoft/address-widget
php bin/magento module:enable Mastersoft_AddressWidget
php bin/magento setup:upgrade

If successful, you should find the module source in /var/www/html/vendor/mastersoft/address-widget/ directory.

Verify Mastersoft_AddressWidget module has been installed properly: php bin/magento module:status. It should be listed in the Enabled Modules.

Next is to configure Mastersoft Address Configuration.

Updating Existing Composer Installation

For example to update to Mastersoft Address Widget v1.0.2.

composer require mastersoft/address-widget:1.0.2 --no-update
composer update
php bin/magento setup:upgrade

(Optional) Follow steps in Additional Steps - For Production Mode Only.

If the page is blank or encounter permission error in the admin store or store homepage, see Installation Troubleshooting.

Manual Installation

Download the zip file in ZIP directory.
Unzip it in your Magento2 Home directory, it will merge with existing directories and files.

You should find the module source in /var/www/html/app/code/Mastersoft/AddressWidget/ directory.

/var/www/html# cp composer.json composer.json.old
php bin/magento module:enable Mastersoft_AddressWidget
php bin/magento setup:upgrade

Verify Mastersoft_AddressWidget module has been installed properly: php bin/magento module:status. It should be listed in the Enabled Modules.

Next is to configure Mastersoft Address Configuration.

Additional Steps - For Production Mode Only

These are additional steps after php bin/magento setup:upgrade - for Production mode only.

php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy en_AU en_US

Installation Troubleshooting

If the page is blank or encounter permission error or other errors in the store homepage.

php bin/magento cache:clean
php bin/magento cache:flush
chown -R :www-data var/cache
chmod -R 777 app/ var/ pub/ generated/ 
rm -rf var/cache/* var/page_cache/*

Configuration

In Magento2 Admin Dashboard of your Store: go to Stores -> Configuration -> Services -> Mastersoft Address.

Get your FREE licence key here.

To configure the Widget Options, here is the full list of available FeatureOption.

For more detail, please see the Configuration in User Guide.

Disable/Enable Module

There are 2 ways to disable/enable this module:

In Mastersoft Address Configuration: Enable Module field OR

In Magento Command

// Disable module
php bin/magento module:disable Mastersoft_AddressWidget --clear-static-content

// Enable module
php bin/magento module:enable Mastersoft_AddressWidget

php bin/magento setup:upgrade
php bin/magento module:status

Uninstallation

Composer Uninstallation

This will work only if the module has been installed using Composer.

php bin/magento module:disable Mastersoft_AddressWidget --clear-static-content
php bin/magento module:uninstall Mastersoft_AddressWidget -r -c
php bin/magento setup:upgrade
composer remove mastersoft/address-widget

Manual Uninstallation

php bin/magento module:disable Mastersoft_AddressWidget --clear-static-content
php bin/magento setup:upgrade

// If was installed using Composer
rm -rf vendor/mastersoft

// If was installed manually
rm -rf app/code/Mastersoft

Remove module data in magento2 database:

DELETE FROM setup_module WHERE module='Mastersoft_AddressWidget';
DELETE FROM core_config_data WHERE path like 'Mastersoft_AddressWidget/%';

Remove Mastersoft_AddressWidget module reference from app/etc/config.php file.

php bin/magento setup:upgrade
php bin/magento cache:flush

User Guide

For more detail documentation, please refer to this User Guide.

Support

If you have any questions or issues with this module, open an issue on GitHub. Alternatively you can contact us via e-mail or via our website below.

E-mail: customer.support@gbgplc.com
Homepage: https://www.mastersoftgroup.com/

mastersoft / address-widget

Maintainers

Details