Merge pull request #31 from marbiano/env-template

Add .env.template
vercel · Oct 28, 2020 · f5a4755 · f5a4755 · vercel · Oct 28, 2020
2 parents 6fe205a + 5fcca0f
commit f5a4755
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/.env.template b/.env.template
@@ -0,0 +1,5 @@
+BIGCOMMERCE_STOREFRONT_API_URL=
+BIGCOMMERCE_STOREFRONT_API_TOKEN=
+BIGCOMMERCE_STORE_API_URL=
+BIGCOMMERCE_STORE_API_TOKEN=
+BIGCOMMERCE_STORE_API_CLIENT_ID=
diff --git a/README.md b/README.md
@@ -68,6 +68,8 @@ Our commitment to Open Source can be found [here](https://vercel.com/oss).
 2. Create a new branch `git checkout -b MY_BRANCH_NAME`
 3. Install yarn: `npm install -g yarn`
 4. Install the dependencies: `yarn`
-5. Run `yarn dev` to build and watch for code changes
-6. The development branch is `development` (this is the branch pull requests should be made against).
+5. Duplicate `.env.template` and rename it to `.env.local`.
+6. Add proper store values to `.env.local`.
+7. Run `yarn dev` to build and watch for code changes
+8. The development branch is `development` (this is the branch pull requests should be made against).
    On a release, the relevant parts of the changes in the `staging` branch are rebased into `master`.