From 44eebf07716b8248bdb3b20f3e46f86422ae7691 Mon Sep 17 00:00:00 2001
From: Jessica McInchak <jessica.mcinchak@gmail.com>
Date: Tue, 17 Oct 2023 20:50:37 +0100
Subject: [PATCH] chore: update local development instructions in README
 (#2321)

---
 .env.example         |  6 ++++--
 README.md            | 32 ++++++++++++++++++++++++++++++--
 editor.planx.uk/.env |  1 +
 3 files changed, 35 insertions(+), 4 deletions(-)

diff --git a/.env.example b/.env.example
index 4e8efb2dfb..9923f8542a 100644
--- a/.env.example
+++ b/.env.example
@@ -6,10 +6,12 @@
 API_PORT=7002
 API_URL_EXT=http://localhost:${API_PORT}
 
+# JWT_SECRET must be at least 32 characters
 JWT_SECRET=👻
 
 SESSION_SECRET=👻
 
+# Google Cloud OAuth 2.0 Client ID
 GOOGLE_CLIENT_ID=👻
 GOOGLE_CLIENT_SECRET=👻
 
@@ -49,9 +51,9 @@ MINIO_ADMIN_PORT=9001
 
 # PostgreSQL
 PG_PORT=7001
-PG_DATABASE=👻
+PG_DATABASE=planxdb
+PG_USERNAME=dbuser
 PG_PASSWORD=👻
-PG_USERNAME=👻
 
 # PG user with permission to sync content between environments
 PRODUCTION_PG_URL_FOR_USER_GITHUB_ACTIONS=👻
diff --git a/README.md b/README.md
index 975dba3547..fddfd4c0e5 100644
--- a/README.md
+++ b/README.md
@@ -26,11 +26,14 @@ planx-new is a monorepo containing our full application stack. Here's a quick su
 
 1. Download and install the following dependencies if you don't have them already:
 - [Docker](https://docs.docker.com/get-docker/)
-- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
+- [Docker Compose](https://docs.docker.com/compose/install/)
 - [PNPM](https://github.com/pnpm/pnpm) `npm install -g pnpm@8.6.6`
 - [Node](https://nodejs.org/en/download) `pnpm env use --global 18.16.1`
+- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
 
-1. Clone this repository.
+**If you're an OSL developer:**
+
+1. Clone this repository
 
 2. Setup your AWS CLI client with SSO - [detailed guide here](https://github.com/theopensystemslab/planx-new/blob/main/doc/how-to/how-to-setup-aws-sso-credentials.md)
 
@@ -48,6 +51,30 @@ planx-new is a monorepo containing our full application stack. Here's a quick su
 
 9. Open `http://localhost:3000` and login with your Google email address
 
+**If you're not a member of OSL, follow these steps:**
+
+1. Fork or clone this repository
+
+2. Copy all `.example` env files into their respective directories and replace 👻 with a string like "SECRET" or longer where noted
+
+3. Setup free OAuth Client ID credentails in the [Google Cloud APIs console](https://console.cloud.google.com/apis/credentials)
+  - Application type = "Web application"
+  - Authorised JavaScript origins = "http://localhost:3000"
+  - Authorised redirect URIs = "http://localhost:7002/auth/google/callback"
+  - Update the `GOOGLE_CLIENT_ID` & `GOOGLE_CLIENT_SECRET` env vars with your new credentials
+
+4. Run `pnpm start` from the project root to set up docker containers for the application's backend (postgres, sharedb, api and hasura server processes). Please note you will not be able to run commands that sync seed data from production.
+
+5. Move into the hasura directory `cd ../hasura.planx.uk` and install dependencies `pnpm i`.
+
+6. Open [Hasura's](https://hasura.io/) web console (`cd hasura.planx.uk` then `pnpm start`) and add your Google email address to the `users` table. You'll also likely want to create an initial `team`. This will eventually allow you to authenticate into the application as an admin.
+
+7. Follow steps 7-9 above to start the editor and login !
+
+At this point you'll be running the full Planx application locally in a docker container. See our Github Actions pull request workflow as an example of how to deploy via docker to a virtual linux server, or explore the `infrastructure` directory for how to deploy via Pulumi infrastructure-as-code to AWS. 
+
+We'd love to hear what you're building on Planx, don't hesitate to get in touch with questions.
+
 ### Docker
 
 The root of the project has several scripts set up to help you manage your docker containers:
@@ -111,3 +138,4 @@ There are a few dependent packages that are closely related to this project:
 
  - https://github.com/theopensystemslab/planx-core
  - https://github.com/theopensystemslab/map
+ - https://github.com/theopensystemslab/digital-planning-data-schemas
diff --git a/editor.planx.uk/.env b/editor.planx.uk/.env
index bfc257b33f..033982c6fe 100644
--- a/editor.planx.uk/.env
+++ b/editor.planx.uk/.env
@@ -1,5 +1,6 @@
 # Used in local development and testing, overwritten in .env.production
 # This file does not (and should not) contain secrets - all values here are publicly exposed
+# If you're working off a fork of Planx, please replace the AIRBRAKE and FEEDBACK_FISH values with a mock value like "SECRET"
 
 REACT_APP_AIRBRAKE_PROJECT_ID=329753
 REACT_APP_AIRBRAKE_PROJECT_KEY=388fe6f4cc0d6644c923500d5672a5b6