Skip to content

Commit 5fcca0f

Browse files
committed
Add an env template and some notes in the readme
1 parent 6fe205a commit 5fcca0f

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

.env.template

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
BIGCOMMERCE_STOREFRONT_API_URL=
2+
BIGCOMMERCE_STOREFRONT_API_TOKEN=
3+
BIGCOMMERCE_STORE_API_URL=
4+
BIGCOMMERCE_STORE_API_TOKEN=
5+
BIGCOMMERCE_STORE_API_CLIENT_ID=

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ Our commitment to Open Source can be found [here](https://vercel.com/oss).
6868
2. Create a new branch `git checkout -b MY_BRANCH_NAME`
6969
3. Install yarn: `npm install -g yarn`
7070
4. Install the dependencies: `yarn`
71-
5. Run `yarn dev` to build and watch for code changes
72-
6. The development branch is `development` (this is the branch pull requests should be made against).
71+
5. Duplicate `.env.template` and rename it to `.env.local`.
72+
6. Add proper store values to `.env.local`.
73+
7. Run `yarn dev` to build and watch for code changes
74+
8. The development branch is `development` (this is the branch pull requests should be made against).
7375
On a release, the relevant parts of the changes in the `staging` branch are rebased into `master`.

0 commit comments

Comments
 (0)