Skip to content

README.md

Latest commit

 

History

History
70 lines (46 loc) · 2.54 KB

README.md

File metadata and controls

70 lines (46 loc) · 2.54 KB
Raw

Spree Address Autocomplete

Spree Address Autocomplete is a convenient extension for the Spree Commerce platform, designed to enhance the user experience by providing address autocomplete functionality. With this extension, users can effortlessly fill in address details during checkout, account creation, or while creating orders and customers from the admin panel.

Features

  • Google Places API Integration: Utilizes Google Places API to suggest related addresses as users begin filling in their address details.
  • Automatic Field Population: Automatically fills in related address fields such as city, state, zip code, and country based on the selected address suggestion.

Installation

  1. Add this extension to your Gemfile with this line:

    gem 'spree_address_autocomplete'

  2. Install the gem using Bundler

    bundle install

  3. Copy & run migrations

    bundle exec rails g spree_address_autocomplete:install

  4. Restart your server

If your server was running, restart it so that it can find the assets properly.

Configuration

To enable this integration:

  1. Navigate to store's settings and configure the Google Places API key for the Spree Address Autocomplete Extension.
  2. Once configured, the integration will be enabled and ready to use.

Usage

Once the extension is installed and configured, users can start experiencing the benefits of address autocomplete across various areas of your Spree Commerce platform, including:

  • Checkout Process: Address autocomplete simplifies the checkout process by suggesting and populating address fields as users begin typing.
  • Account Creation: Enhance user registration and account creation by streamlining address input.
  • Customer and Order Management: Simplify the process of creating and updating customer or order details directly from the admin panel with the assistance of address autocomplete.

Testing

First bundle your dependencies, then run rake. rake will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using rake test_app.

bundle update
bundle exec rake

When testing your applications integration with this extension you may use it's factories. Simply add this require statement to your spec_helper:

require 'spree_address_autocomplete/factories'

Releasing

bundle exec gem bump -p -t
bundle exec gem release

For more options please see gem-release REAMDE