From 5fcca0fe31bf8ea9d0cd6157bd14b161c7042294 Mon Sep 17 00:00:00 2001 From: Martin Bavio Date: Wed, 28 Oct 2020 02:00:38 -0300 Subject: [PATCH] Add an env template and some notes in the readme --- .env.template | 5 +++++ README.md | 6 ++++-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 .env.template diff --git a/.env.template b/.env.template new file mode 100644 index 000000000..73a8a6e3b --- /dev/null +++ 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= \ No newline at end of file diff --git a/README.md b/README.md index 1afa87f56..76b311e42 100644 --- 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`.