Skip to content
This repository has been archived by the owner on Apr 26, 2022. It is now read-only.

Commit

Permalink
README doc update (#156)
Browse files Browse the repository at this point in the history
- README doc update
  • Loading branch information
shaunmaharaj authored May 31, 2020
1 parent cad5b6b commit 47867b3
Showing 1 changed file with 2 additions and 36 deletions.
38 changes: 2 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,43 +14,9 @@

🚨 THIS IS A WIP - CONTRIBUTORS WELCOME 😍

## Setup
## Documentation 📖

You'll need an [Elastic Path Commerce Cloud account](https://dashboard.elasticpath.com) to run this store.

Run the following commands in your Terminal:

```bash
gatsby new gatsby-demo-store https://github.com/moltin/gatsby-demo-store
cd gatsby-demo-store
yarn
```

Once you have the project setup, you can now configure the ENV variables required to run the project.

⚠️ You will need to create an account with [Algolia](https://algolia.com) for search and [Algolia places](https://community.algolia.com/places). Algolia is used to power the search page and Algolia places is used during the checkout process for quick address lookup.

Create a `.env` file in the root directory and add the following with your secrets:

```dosini
GATSBY_MOLTIN_CLIENT_ID=
GATSBY_STRIPE_PUBLISHABLE_KEY=
GATSBY_ALGOLIA_PLACES_APP_ID=
GATSBY_ALGOLIA_PLACES_API_KEY=
GATSBY_ALGOLIA_INDEX_NAME=
ALGOLIA_ADMIN_KEY=
GATSBY_ALGOLIA_API_KEY=
GATSBY_ALGOLIA_APP_ID=
GATSBY_ITEMS_PER_PAGE=
```

You must also configure Stripe inside the [Dashboard](https://dashboard.elasticpath.com).

Now you're ready to go!

```bash
yarn dev
```
- [Gatsby Demo Store Documentation](https://documentation.elasticpath.com/commerce-cloud/docs/developer/get-started/gatsby-demo-store.html)

## Terms And Conditions

Expand Down

0 comments on commit 47867b3

Please sign in to comment.