@gocrisp/store-locator

Archival note: The Crisp GeoJSON outbound connector is deprecated and no longer available.

A store locator component for use on any website. Intended for use with the Crisp GeoJSON connector.

This uses the Google Maps JavaScript API to easily create a simple store locator from any GeoJSON source.

This package is intended to be framework-agnostic. We are using microbundle to create a package that supports many formats (CJS, UMD, ESM). Since we like to use TypeScript, types are available (but not required). And since we love React, we have also published a React Component version.

Please refer to our example page to see this package in action and for more advanced usage examples. The steps below will provide the minimum for creating a store locator.

Create a Store Locator

Set up services

First, go set up a GeoJSON outbound connector on https://platform.gocrisp.com/. It will give you a URL to use later.

Create a Google Maps API Key with the following APIs enabled:

• Maps JavaScript API
• Places API
• Distance Matrix API.
• Street View Static API

Simple Implementation

Install this package:

yarn add @gocrisp/store-locator

or

npm install @gocrisp/store-locator --save

Include the styles: We have some minimal styles included as plain css in @gocrisp/store-locator/dist/store-locator.css. You will need to pull this into your site however you are including styles. We've kept the definitions as minimal as possible so that you can easily override or recreate the styles yourself. And every class is namespaced with the map_ prefix to avoid collisions.

Then, wherever you want to include the store locator map, insert this snippet:

import { createStoreLocatorMap } from '@gocrisp/store-locator';

createStoreLocatorMap({
  component: document.getElementById('store-locator-map'),
  geoJson: '<URL from the GeoJSON connector>',
  loaderOptions: { apiKey: '<your Google Maps API key>' },
});

Most of the Google Maps JavaScript API options and objects are available for customization as well. More details are available in the examples and documentation.

Run the Example App Locally

You should add a .env.local file that contains a GOOGLE_MAPS_API_KEY, otherwise the Google Maps will be limited.

To run the example app locally, you need to build the npm package into dist and then run the example app. You can either run the store-locator code with yarn dev to watch for changes or build it once with yarn build, but with the former you will need to run dev and example simultaneously.

yarn install
yarn start