Update README with new instructions and improve setup

This changeset updates the README.md file with a set of entirely new instructions. These updates are intended to improve clarity, simplify steps, and reduce confusion and environment-setup gotchas that folks have run into previously and we have learned from.  A couple of other changes are also included:

- Minor adjustments to the Makefile to improve make bootstrap
- Updates to the sample.env file to include previously missing required environment variables

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This commit is contained in:
Carlo Costino
2023-11-15 13:34:04 -05:00
parent 7d5d2d4200
commit 7c1fa1bd75
3 changed files with 298 additions and 47 deletions

View File

@@ -39,6 +39,13 @@ NOTIFY_APP_NAME=api
#############################################################
# E2E Testing
NOTIFY_E2E_TEST_EMAIL=example@fake.gov
NOTIFY_E2E_TEST_PASSWORD="don't write secrets to the sample file"
#############################################################
# Flask
FLASK_APP=application.py
FLASK_DEBUG=true