4
0
forked from crowetic/commerce

Add an env template and some notes in the readme

This commit is contained in:
Martin Bavio 2020-10-28 02:00:38 -03:00
parent 6fe205a163
commit 5fcca0fe31
2 changed files with 9 additions and 2 deletions

5
.env.template Normal file
View File

@ -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=

View File

@ -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`.