darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-09-11 10:28:55 -04:00
Code Issues Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Beverly Nguyen
2023-11-14 09:34:50 -08:00
parent 48b18b9366
commit a28358c0db
1 changed files with 33 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -14
View File
@@ -15,24 +15,26 @@ Our other repositories are:
- [us-notify-compliance](https://github.com/GSA/us-notify-compliance/) - [us-notify-compliance](https://github.com/GSA/us-notify-compliance/)
- [notify-python-demo](https://github.com/GSA/notify-python-demo) - [notify-python-demo](https://github.com/GSA/notify-python-demo)
## Local setup ## Local setup
### Common steps ### Common steps
On MacOS, using [Homebrew](https://brew.sh/) for package management is highly recommended. This helps avoid some known installation issues. On MacOS, using [Homebrew](https://brew.sh/) for package management is highly recommended. This helps avoid some known installation issues.
_Note: If brew is not found: Verify that Homebrew is in your system's PATH. You may need to follow additional instructions to add Homebrew to your PATH in /Users/homefolder/.zprofile:_
1. Install pre-requisites for setup: 1. Install pre-requisites for setup:
* [jq](https://stedolan.github.io/jq/): `brew install jq` - [jq](https://stedolan.github.io/jq/): `brew install jq`
* [terraform](https://www.terraform.io/): `brew install terraform` or `brew install tfenv` and use `tfenv` to install `terraform ~> 1.4.0` - [terraform](https://www.terraform.io/): `brew install terraform` or `brew install tfenv` and use `tfenv` to install `terraform ~> 1.4.0`
* [cf-cli@8](https://docs.cloudfoundry.org/cf-cli/install-go-cli.html): `brew install cloudfoundry/tap/cf-cli@8` - [cf-cli@8](https://docs.cloudfoundry.org/cf-cli/install-go-cli.html): `brew install cloudfoundry/tap/cf-cli@8`
* [postgresql](https://www.postgresql.org/): `brew install postgresql@15` (Homebrew requires a version pin, but any recent version will work) - [postgresql](https://www.postgresql.org/): `brew install postgresql@15` (Homebrew requires a version pin, but any recent version will work)
* [redis](https://redis.io/): `brew install redis` - [redis](https://redis.io/): `brew install redis`
* [pyenv](https://github.com/pyenv/pyenv): `brew install pyenv` - [pyenv](https://github.com/pyenv/pyenv): `brew install pyenv`
* [poetry](https://python-poetry.org/docs/#installation): `brew install poetry` - [poetry](https://python-poetry.org/docs/#installation): `brew install poetry`
1. [Log into cloud.gov](https://cloud.gov/docs/getting-started/setup/#set-up-the-command-line): `cf login -a api.fr.cloud.gov --sso` 1. [Log into cloud.gov](https://cloud.gov/docs/getting-started/setup/#set-up-the-command-line): `cf login -a api.fr.cloud.gov --sso`
1. Ensure you have access to the `notify-local-dev` and `notify-staging` spaces in cloud.gov 1. Ensure you have access to the `notify-local-dev` and `notify-staging` spaces in cloud.gov
1. Run the development terraform with: 1. Run the development terraform
_(Be sure to clone the repository first and navigate to the terraform directory):_
``` ```
$ cd terraform/development $ cd terraform/development
@@ -47,8 +49,9 @@ On MacOS, using [Homebrew](https://brew.sh/) for package management is highly re
brew services start redis brew services start redis
``` ```
1. Install #### Install
1. Run the project setup
1. Run the project setup (If there are errors, check for Python versions >=3.9,<3.12. Ensure that you have the required database set up and migrations)
`make bootstrap` `make bootstrap`
@@ -56,13 +59,13 @@ On MacOS, using [Homebrew](https://brew.sh/) for package management is highly re
`make run-procfile` `make run-procfile`
1. Or run them individually: - Or run them individually:
* Run Flask (web server) - Run Flask (web server)
`make run-flask` `make run-flask`
* Run Celery (background worker) - Run Celery (background worker)
`make run-celery` `make run-celery`