Updated README for new dev setup

Signed-off-by: Christopher Andrew Hinchey <[email protected]>
p-oneil · Mar 2, 2023 · 1bdcdd0 · 1bdcdd0
1 parent 132ccaa
commit 1bdcdd0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/.env-sample b/.env-sample
@@ -1,5 +1,7 @@
 # ------------ Strapi ------------ #
+# URL where strapi is hosted
 STRAPI_URL=CHANGEME
+# Normally STRAPI_URL + '/graphql'
 GQL_HOST=CHANGEME
 
 # ------------ Playwright ------------ #

diff --git a/README.md b/README.md
@@ -15,8 +15,9 @@ This repository contains the frontend source code for the upcoming new https://s
 1. [Fork repository](https://github.com/mitre/saf-site) and clone it locally
 2. Install project dependencies: `yarn install`
 3. Install playwright dependencies with `npx playwright install`
-4. For developing use: `yarn dev`
-5. For production use: `yarn build` and `yarn preview` 
+5. Copy `.env-sample` into `.env` and replace `CHANGEME` values as appropriate
+6. For developing use: `yarn dev`
+7. For production use: `yarn build` and `yarn preview` 
 
 [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://mitre-saf-v2.netlify.app/)