darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-05-03 15:50:12 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README with new instructions and improve setup

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@@ -12,9 +12,9 @@ GIT_COMMIT ?= $(shell git rev-parse HEAD)
.PHONY: bootstrap
bootstrap: ## Set up everything to run the app
make generate-version-file
poetry install --sync --no-root
poetry self add poetry-dotenv-plugin
poetry self update
poetry self add poetry-dotenv-plugin
poetry install --sync --no-root
poetry run pre-commit install
createdb notification_api || true
(poetry run flask db upgrade) || true