Merge pull request #11 from JSv4/JSv4/update-docs

Added frontend .env file samples and guidance.
JSv4 · Oct 24, 2022 · a1aedb5 · a1aedb5
2 parents 5c0fac1 + 5aab32f
commit a1aedb5
Show file tree

Hide file tree

Showing 14 changed files with 36 additions and 2 deletions.
diff --git a/docs/configuration/choose-and-configure-docker-stack.md b/docs/configuration/choose-and-configure-docker-stack.md
@@ -9,10 +9,24 @@ A "local" deployment is deployed on your personal computer and is not meant to b
 don't need to configure anything, just follow the quick start guide above to get up and running with a local deployment
 without needing any further configuration.
 
-#### Customize Settings
+#### Setup .env Files
+
+##### Backend
 
 After cloning this repo to a machine of your choice, create a folder for your environment
-files in the repo root. You'll need `./.envs/.local/.django` and `./.envs/.local/.postgres` Use the samples in `./documentation/sample_env_files/local` as guidance. NOTE, you'll need to replace the placeholder passwords and users where noted, but, otherwise, minimal config should be required.
+files in the repo root. You'll need `./.envs/.local/.django` and `./.envs/.local/.postgres`
+Use the samples in `./documentation/sample_env_files/local` as guidance.
+NOTE, you'll need to replace the placeholder passwords and users where noted, but, otherwise, minimal config should be
+required.
+
+##### Frontend
+
+In the `./frontend` folder, you also need to create a single .env file which holds your configurations for your login
+method as well as certain feature switches (e.g. turn off imports). We've included a sample using auth0 and
+another sample using django's auth backend. Local vs production deployments are essentially the same, but the root
+url of the backend will change from localhost to whereever you're hosting the application in production.
+
+#### Build the Stack
 
 Once your .env files are setup, build the stack using docker-compose:
 

diff --git a/docs/sample_env_files/local/.django → docs/sample_env_files/backend/local/.django b/docs/sample_env_files/local/.django → docs/sample_env_files/backend/local/.django
diff --git a/docs/sample_env_files/local/.gremlinengine → ...le_env_files/backend/local/.gremlinengine b/docs/sample_env_files/local/.gremlinengine → ...le_env_files/backend/local/.gremlinengine
diff --git a/...e_env_files/local/.gremlinengine.postgres → ...les/backend/local/.gremlinengine.postgres b/...e_env_files/local/.gremlinengine.postgres → ...les/backend/local/.gremlinengine.postgres
diff --git a/docs/sample_env_files/local/.postgres → .../sample_env_files/backend/local/.postgres b/docs/sample_env_files/local/.postgres → .../sample_env_files/backend/local/.postgres
diff --git a/docs/sample_env_files/production/.django → ...mple_env_files/backend/production/.django b/docs/sample_env_files/production/.django → ...mple_env_files/backend/production/.django
diff --git a/docs/sample_env_files/production/.frontend → ...le_env_files/backend/production/.frontend b/docs/sample_env_files/production/.frontend → ...le_env_files/backend/production/.frontend
diff --git a/...ample_env_files/production/.gremlinengine → ...v_files/backend/production/.gremlinengine b/...ample_env_files/production/.gremlinengine → ...v_files/backend/production/.gremlinengine
diff --git a/..._files/production/.gremlinengine.postgres → ...ackend/production/.gremlinengine.postgres b/..._files/production/.gremlinengine.postgres → ...ackend/production/.gremlinengine.postgres
diff --git a/docs/sample_env_files/production/.postgres → ...le_env_files/backend/production/.postgres b/docs/sample_env_files/production/.postgres → ...le_env_files/backend/production/.postgres
diff --git a/docs/sample_env_files/frontend/local/django.auth.env b/docs/sample_env_files/frontend/local/django.auth.env
@@ -0,0 +1,3 @@
+REACT_APP_USE_AUTH0=false
+REACT_APP_USE_ANALYZERS=true
+REACT_APP_ALLOW_IMPORTS=true
diff --git a/docs/sample_env_files/frontend/local/with.auth0.env b/docs/sample_env_files/frontend/local/with.auth0.env
@@ -0,0 +1,7 @@
+REACT_APP_APPLICATION_DOMAIN=
+REACT_APP_APPLICATION_CLIENT_ID=
+REACT_APP_AUDIENCE=http://localhost:3000
+REACT_APP_API_ROOT_URL=http://localhost:8000
+REACT_APP_USE_AUTH0=true
+REACT_APP_USE_ANALYZERS=true
+REACT_APP_ALLOW_IMPORTS=true
diff --git a/docs/sample_env_files/frontend/production/django.auth.env b/docs/sample_env_files/frontend/production/django.auth.env
@@ -0,0 +1,3 @@
+REACT_APP_USE_AUTH0=false
+REACT_APP_USE_ANALYZERS=true
+REACT_APP_ALLOW_IMPORTS=true
diff --git a/docs/sample_env_files/frontend/production/with.auth0.env b/docs/sample_env_files/frontend/production/with.auth0.env
@@ -0,0 +1,7 @@
+REACT_APP_APPLICATION_DOMAIN=
+REACT_APP_APPLICATION_CLIENT_ID=
+REACT_APP_AUDIENCE=http://localhost:3000
+REACT_APP_API_ROOT_URL=[your open contracts backend url]
+REACT_APP_USE_AUTH0=true
+REACT_APP_USE_ANALYZERS=true
+REACT_APP_ALLOW_IMPORTS=true