Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.




Section


Column
width50%

Table of Contents

Warning

Firefox user notice:

Please use another web browser to view this document.

Sorry for the inconvenience.



Column
width30%

                                                                                                                                                                                                   

Magento 2 Store Locator is a straightforward solution enabling purchasers to find nearby physical locations of a web store by concrete address or current location distance. From the frontend area, store admins can quickly create new locations of their outlets and add the appropriate markers to Google Maps on individual store views. Additionally, they can set the map zoom, latitude, and longitude values of each created location. 

Compatibility: Magento Open Source 2.3.X - 2.4.X, Magento Commerce 2.3.X - 2.4.X.

Product Page


...

Command Line InstallationComposer Installation


Panel
borderWidth2px
borderStylesolid

1. Backup your web directory and store database


Panel
borderWidth2px
borderStylesolid

2. Download the Store Locator installation package


Panel
borderWidth2px
borderStylesolid

 3. Upload contents of the Store Locator installation package to your store root directory


Panel
borderWidth2px
borderStylesolid

 4. In SSH console of your server navigate to your store root folder:

No Format
cd path_to_the_store_root_folder

run the following command: :

No Format
php -f bin/magento module:enable Aheadworks_StoreLocator

then:

No Format
php -f bin/magento setup:upgrade

after:

No Format
php -f bin/magento setup:static-content:deploy


Panel
borderWidth2px
borderStylesolid

5. Flush store cache; log out from the backend and log in again


Note

Make sure the installation is done from the FTP administrator account. Otherwise, set 775 permissions to the store root directory after the extension is deployed.




Column
width50%


Panel
borderWidth2px
borderStylesolid

If you are installing an extension from Aheadworks for the first time, you need to add our composer repository to your Magento store:

Panel
borderWidth2px
borderStylesolid

1. Login to your ssh console and navigate to your store folder:

Panel
borderWidth2px
borderStylesolid
cd path_to_the_store_root_folder

Run the following command:

Panel
borderWidth2px
borderStylesolid
composer config repositories.aheadworks composerhttps://dist.aheadworks.com/

On successful execution of the command you will be able to use the composer to install the extensions.



Panel
borderWidth2px
borderStylesolid

To install the extension:

2. Login to your ssh console and navigate to your store folder:

Panel
borderWidth2px
borderStylesolid
cd path_to_the_store_root_folder



Panel
borderWidth2px
borderStylesolid

 3. Run the following command to install the latest version of the extension:

Panel
borderWidth2px
borderStylesolid
composer require aheadworks/module-store-locator

if you need to install a specific version, run this command:

Panel
borderWidth2px
borderStylesolid
composer require aheadworks/module-store-locator:<version>


Tip

Specify the desirable extension version in <version>.


Panel
borderWidth2px
borderStylesolid

When prompted, enter Public Key (Username) and Private Key (Password):


Note

Both Public Key (Username) and Private Key (Password) can be found in My Projects and Licenses in your personal account on our site:

Image Modified



Panel
borderWidth2px
borderStylesolid

4. Enable the extension:

Panel
borderWidth2px
borderStylesolid
php -f bin/magento module:enable <Module_Name>


Tip

Specify the version of the extension in <version>

Next, register the extension:

Panel
borderWidth2px
borderStylesolid
bin/magento setup:upgrade

Recompile your Magento store if you are in the Production mode:

Panel
borderWidth2px
borderStylesolid
bin/magento setup:di:compile

To verify that the extension is enabled, run this command:

Panel
borderWidth2px
borderStylesolid
bin/magento module:status

Clean store cache, by running the following command:

Panel
borderWidth2px
borderStylesolid
bin/magento cache:clean

Log out and Log in the backend again.


Panel
borderWidth2px
borderStylesolid

To upgrade the extension:

5. To update or upgrade an extension:

Download the updated extension file. Take note of the module-name and version. Export the contents to your Magento root.

If a composer package exists for the extension, run one of the following.


Code Block
titleUpdate per module name:
composer update aheadworks/module-store-locator


Code Block
titleUpdater per version:
composer require aheadworks/module-store-locator:<version>

Run the following commands to upgrade, deploy, and clean the cache.

Panel
borderWidth2px
borderStylesolid
php bin/magento setup:upgrade --keep-generated
php bin/magento setup:static-content:deploy
php bin/magento cache:clean







Adding the store location


Section

Store Locator extension comes ready for work right after the installation.

The first thing you want to do is to add the location of your store to the map. To do this, navigate to Content > Store Locator by aheadWorks:

Image ModifiedContent > Store Locator by aheadWorks


This screen is a management center of all your store locations. Whether you want to add a new location, edit previously created one, or find a particular location by any attribute, - this is the place you are looking for.

To add new store location click  button at the top right-hand corner of the screen.

  • In the General Information section of the New Location screen you are suggested to specify the store location related values such as country, street, and phone;
  • At the Google Maps Settings section of the New Location screen you can either manually specify the latitude and longitude of the store or click  button to let Google Maps do it for you;
  • Once everything is done - click  button.


Info


Expand
titleClick to see how the attributes will affect the store look...


That's it, you have just added your first store location.

Adjusting Store Locator settings

Section

You have added the location of a store and definitely want to look through it. It is now high time to proceed to the Store Locator settings screen to learn how to do it.

Image Modified

Stores > Configuration > aheadWorks extensions > Store Locator

General settings

The extension is enabled by default after the installation, however, the Extension's URL to Top Menu option that brings the Store Locator section to the frontend navigation menu is disabled.

Let's go through the settings available and what they do:

  • Enable Store Locator Page - allows enabling/disabling the extension and the Store Locator frontend page in particular;
  • Title - defines the Store Locator page title;
  • URL Key - defines the links the Store Locator page will be accessible by;
  • Google Maps API Key - this setting is only relevant for store owners running customer heavy stores with 25k+ Google Map loads per day if you do not have this many loads you do not need to enter the Google Maps API;
  • Extension's URL to Top Menu - allows adding the Store Locator page link to the top category menu at the frontend;
  • Header CMS Block - allows displaying any CMS block at the Store Locator page.
Info

Back to the store location you have added.

For testing purposes, you can leave Extension's URL to Top Menu option disabled and access the Store Locator page directly by the URL Key specified.

Say you need to add several store locations and want to have a look at them before letting your customers access the page.

In this case, you can add the store locator URL Key ('store-locations' as in the example above) to your store URL:

No Format
yourstore.com/store-locations

and thus access the Store Locator page without revealing the link before your customers.

Once you have applied all the settings changes and decided on where at the Top Menu you want the Extension's URL displayed you may want to proceed to Search and SEO settings:

Image ModifiedStores > Configuration > aheadWorks extensions > Store Locator


Search and SEO settings

Search settings let you enhance customer's search experience:

  • Search Radius - allows defining a set of search radii available for customers;
  • Default Search Radius - defines the search radius set by default at the Store Locator page;
  • Default Search Measurement - miles/kilometers.


Info


Expand
titleClick to see the search options...

Image Modified

Store Locator offers a quick navigation.

  • Customers can either manually start typing the location for Google Map suggestions to pop up;
  • Or click  button and Google Maps will identify the customer's current location automatically.

Once the Current Location is set customers are suggested to select a Search Radius and Search Radius Measurement from the appropriate boxes and then click the  button.

That's it. The Store Locator will display all the stores available for customers nearby.


SEO settings let you type in the Meta Keywords and Meta Description of the Store Locator page.

Once you are done with Search and SEO settings click  button.

Congratulations! You have successfully set up and configured Store Location extension. Now you may want to add more store locations.

Importing Locations via CSV 


Section

In case if you want to add multiple store locations at once, you can take advantage of the provided import functionality. This functionality is integrated into the native Magento Data Import section located at: System > Data Transfer > Import.

The Entity Type section contains the Aheadworks Store Locator - Locations option, which, if selected, enables an import configuration form with two configuration blocks, Import Behavior and File to Import.

Image ModifiedSystem > Data Transfer > Import > Aheadworks Store Locator - Locations


Import Behavior

The Import Behavior set contains the following options:

  • Import Behavior. The box contains two options: Add Locations and Delete Locations and Add Locations. If the first option is selected, the functionality adds new locations to existing ones. If the second option is chosen, the module will replace previous locations with the new ones;
  • Stop on Error / Skip Error Entries. You can choose either to stop the import process each time an error is detected or skip errors and continue importing;
  • Allowed Errors Count. Defines the number of errors to cease the import process;
  • Field Separator. The symbol that separates fields;
  • Multiple Value Separator. The symbol that separates multiple values;
  • Fields Enclosure. Tick the button in case if you upload files containing spreadsheets.

File to Import

The File to Import configuration section contains the following options:

  • Select File to Import. The option allows you to select a CSV file to be imported.
Info

Please make sure that the file doesn't exceed the limit of 2 Mb.

  • Images File Directory. Using this option you can set a path to images in the imported file. For example, if the images are stored in the store_root/pub/media/import/aw folder, the path is going to be aw/image.png.


...

Product Page

Need Customization?

You can always find the latest version of the software, full documentation, demos, screenshots, and reviews on http://aheadworks.com
License agreement: https://aheadworks.com/end-user-license-agreement
Contact Us: https://aheadworks.com/contact
Copyright © 2021 Aheadworks Co. http://www.aheadworks.com

...