darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-22 16:31:15 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' of https://github.com/GSA/notifications-api into message-send-flow-docs

Browse Source
This commit is contained in:
Andrew Shumway
2024-03-28 09:36:01 -06:00
parent 1547e80e37 8d11133d4e
commit 622a8b9fd7
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -278,6 +278,9 @@ in the command line by using this command:
```sh ```sh
cf login -a api.fr.cloud.gov --sso cf login -a api.fr.cloud.gov --sso
``` ```
If you are offered a choice of orgs, select `gsa-tts-benefits-studio`.
For the space, choose `notify-local-dev` to start with (assuming you are
setting up local development).
_REMINDER: Ensure you have access to the `notify-local-dev` and `notify-staging` spaces in cloud.gov_ _REMINDER: Ensure you have access to the `notify-local-dev` and `notify-staging` spaces in cloud.gov_
@@ -289,9 +292,12 @@ cd terraform/development
./run.sh ./run.sh
``` ```
In addition to some infrastructure setup, this will also create a local `.env` If this runs correctly, Terraform will ask you if you want to create some
file for you in the project's root directory, which will include a handful of resources. Answer `yes`.
project-specific environment variables.
The script will also create a local `.env` file for you in the project's
root directory, which will include a handful of project-specific environment
variables.
Lastly, if you didn't already start PostgreSQL and Redis above, be sure to do Lastly, if you didn't already start PostgreSQL and Redis above, be sure to do
so now: so now:
@@ -385,6 +391,9 @@ Now you can run the web server and background workers for asynchronous jobs:
make run-procfile make run-procfile
``` ```
If it runs correctly, you will be able to visit http://127.0.0.1:6011/ and see
JSON from the API in your web browser.
This will run all of the services within the same shell session. If you need to This will run all of the services within the same shell session. If you need to
run them separately to help with debugging or tracing logs, you can do so by run them separately to help with debugging or tracing logs, you can do so by
opening three sepearate shell sessions and running one of these commands in each opening three sepearate shell sessions and running one of these commands in each