addressfinder/module-magento2 dev-master

Address Autocomplete for your Magento 2 store by AddressFinder

Type

magento2-module

License

OSL-3.0,AFL-3.0

Requires
Requires (dev)

None

Suggests

None

Provides

None

Conflicts

None

Replaces

None

AddressFinder Magento

Using the Magento 2 plugin

Follow the user guide on the AddressFinder website:

Installation

To install the AddressFinder module for Magento 2, simply run:

composer require addressfinder/module-magento2
bin/magento module:enable AddressFinder_AddressFinder
bin/magento setup:upgrade
bin/magento cache:flush

You'll generally need to recompile your dependency injection cache and redeploy themes, especially in production. This process varies from site to site and is outside the context of installing this module, but generally is:

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

Development

Download Docker for Mac

Setup for Magento 2.0 or 2.1

There are different docker-compose files for the versions of Magento and PHP because they all need individual docker volumes for quicker spin-up in development (i.e. you won't have to re-install Magento every time you switch version).

bash setup.sh
docker-compose -f docker-compose.yml -f docker-compose.<versions>.yml up app
open http://localhost:8000/

Create an new admin user. Passwords must be at least 8 characters long, include both numbers and letters, and a variety of cases.

docker-compose -f docker-compose.yml -f docker-compose.<versions>.yml exec phpfpm bash
bin/magento admin:user:create --admin-firstname=kate --admin-lastname=norquay [email protected] --admin-user=kate --admin-password=G00dG00d

Get the Magento Admin path. Each Magento install creates a unique url to the admin portal.

docker-compose -f docker-compose.yml -f docker-compose.<versions>.yml exec phpfpm bin/magento info:adminuri

Setup for Magento 2.2

docker-compose -f docker-compose.new.yml up
docker-compose -f docker-compose.new.yml exec apache rm index.php
docker-compose -f docker-compose.new.yml exec apache install-magento2

Symlink the AddressFinder plugin to the Magento codebase

sed -i '' "s/# SYMLINK PLUGIN HERE/- .\/AddressFinder:\/var\/www\/html\/app\/code\/AddressFinder/" docker-compose.new.yml

To get the module working

  • Change your store configuration to support New Zealand & Australia.

    Do this at Admin > Stores > Configuration > General > Country Options

Logs

You'll find the logs in /var/www/html/var/log

Javascript

Make your changes to ./src/addressfinder_magento.coffee then run gulp to automatically build the addressfinder_magento.js file in the AddressFinder module (See view/frontend/web/js).

Changes will be updated in the Magento codebase immediately.

Where to look

The following table indicates which file to edit for making page specific changes:

File Page
AddressFinder/AddressFinder/view/frontend/templates/customer.phtml Website > My Account > Edit Address
AddressFinder/AddressFinder/view/frontend/templates/checkout.phtml Website > Checkout
AddressFinder/AddressFinder/etc/adminhtml/system.xml, AddressFinder/AddressFinder/etc/config.xml Admin > Stores > Configuration > Services > AddressFinder

Can't see your changes?

RequireJS

Magento allows requirejs-config.js files to be defined per module. Multiple config files are concatenated into a single file.

When making updates to any requirejs-config.js, you may need to recompile static content to see changes.

docker-compose -f docker-compose.yml -f docker-compose.<versions>.yml exec phpfpm bash
rm -rf pub/static/*
bin/magento setup:static-content:deploy
The etc directory

If you modify etc/adminhtml/system.xml or etc/config.xml, you may need to clear and flush the cache to see changes.

docker-compose -f docker-compose.yml -f docker-compose.<versions>.yml exec phpfpm bin/magento cache:clean
docker-compose -f docker-compose.yml -f docker-compose.<versions>.yml exec phpfpm bin/magento cache:flush

Packaging

Run bash package.sh to create a zip package for distribution.