Installing the ShipperHQ Address Auto-Complete Extension

Overview

Please follow these steps to install your extension. These installation instructions provide comprehensive installation guidance. If you do not follow these steps as indicated you may well see issues with your install, which may take some time to resolve. So please follow each step carefully and if the install fails re-check the steps.

Presumptions

We assume you understand Magento 2, and have it installed correctly.

It is highly recommended to backup your server files and database before installing this module. No responsibility can be taken for any adverse effects it may cause. It is also recommended you install on a test server initially to carry out your own testing.

Installation Process

Clean Install

  1. Run the following commands from your root Magento installation directory:
    composer require shipperhq/module-address-autocomplete
    php bin/magento module:enable ShipperHQ_AddressAutocomplete
    php bin/magento setup:upgrade
  2. Flush & Re-enable the cache if required
  3. Remove generated file content by deleting contents of:
    var/view_processed
    pub/static/frontend/
    pub/static/adminhtml/
    var/generation

Updating Existing Installation

Run from your root Magento directory.

  1. Update the extension:
    composer update
    bin/magento setup:upgrade
  2. Flush the cache
  3. Remove generated file content by deleting contents of:
    var/view_processed
    pub/static/frontend/
    pub/static/adminhtml/
    var/generation

Manual Installation

Please note that we recommend the use of Composer (as above), as per Magento 2 standards.

  1. Download the ZIP from the ZIP directory of the Github repo: https://github.com/shipperhq/module-address-autocomplete
  2. Extract the contents of the ZIP to the root of your Magento directory. This will merge into the app directory.
  3. Enable the modules using: php bin/magento module:enable ShipperHQ_AddressAutocomplete
  4. You must also install ShipperHQ to install the necessary dependencies ( note you do not need to enable or subscribe to ShipperHQ to use Address Autocomplete)
  5. Update Magento with: php bin/magento setup:upgrade
  6. Clear cache and re-compile

Post-Installation Steps

Once installed, you can continue to configure the Address Auto-Complete Magento extension.