From f55d3ce34d9e7714ce64ad55d37e8f3097d54d9d Mon Sep 17 00:00:00 2001
From: Josh <30379833+josh-chamberlain@users.noreply.github.com>
Date: Mon, 10 Jun 2024 18:35:57 -0400
Subject: [PATCH] Update README.md

---
 README.md | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index cc0837c7..0e0dc245 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ An API and UI for searching, using, and maintaining Data Sources.
 #### [Live app](https://data-sources.pdap.io/)
 #### [API docs](https://docs.pdap.io/api/introduction)
 
-## Installation
+## Running the app for local development
 
 ### 1. Clone this repository and navigate to the root directory.
 
@@ -50,24 +50,30 @@ pip install -r requirements.txt
 
 ### 5. Add environment secrets
 
-Either add a `.env` file to your local root directory or manually export these secrets: `DO_DATABASE_URL` and `VITE_VUE_API_BASE_URL`.  
-
-Reach out to contact@pdap.io or make noise in Discord if you'd like access to these keys.
+Either add a `.env` file to your local root directory or manually export these secrets. Reach out to contact@pdap.io or make noise in Discord if you'd like access. 
 
+#### Sample `.env` file
 ```
-# .env
+# Local development
+VITE_VUE_API_BASE_URL='http://localhost:5000'
+VITE_VUE_APP_BASE_URL='http://localhost:8888'
+
+# Deployed app
+# VITE_VUE_API_BASE_URL='https://data-sources.pdap.io/api'
+# VITE_VUE_APP_BASE_URL='https://data-sources.pdap.io/'
+
+# Production database and API
+DO_DATABASE_URL='secret'
+SECRET_KEY='secret'
 
-DO_DATABASE_URL="postgres://data_sources_app:<password>@db-postgresql-nyc3-38355-do-user-8463429-0.c.db.ondigitalocean.com:25060/defaultdb"
-VITE_VUE_API_BASE_URL="http://localhost:5000"
-VITE_VUE_APP_BASE_URL="http://localhost:8888"
+# Mailgun key for notifications
+MAILGUN_KEY='secret'
 ```
 
 ```
 # shell
 
 export DO_DATABASE_URL=postgres://data_sources_app:<password>@db-postgresql-nyc3-38355-do-user-8463429-0.c.db.ondigitalocean.com:25060/defaultdb
-export VITE_VUE_API_BASE_URL="http://localhost:5000"
-export VITE_VUE_APP_BASE_URL="http://localhost:8888"
 ```
 
 ### 6. Allow your IP address