From 6b870abdc4ccea2b8cc0deda58c3d44f451f14ef Mon Sep 17 00:00:00 2001 From: John Skiles Skinner Date: Tue, 26 Mar 2024 13:08:34 -0700 Subject: [PATCH 1/3] Add cf org and space to README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index bb38882df..6ec38fb4d 100644 --- a/README.md +++ b/README.md @@ -278,6 +278,7 @@ in the command line by using this command: ```sh 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. _REMINDER: Ensure you have access to the `notify-local-dev` and `notify-staging` spaces in cloud.gov_ From 7b970132554f84d36a43307bc36a305155acd07b Mon Sep 17 00:00:00 2001 From: John Skiles Skinner Date: Wed, 27 Mar 2024 09:05:08 -0700 Subject: [PATCH 2/3] Notes about running ./run.sh and make run-profile Explain what to expect when running `./run.sh` and `make run-profile` so that the user can determine if they have run correctly --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bb38882df..da82c6937 100644 --- a/README.md +++ b/README.md @@ -289,9 +289,12 @@ cd terraform/development ./run.sh ``` -In addition to some infrastructure setup, this 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. +If this runs correctly, Terraform will ask you if you want to create some +resources. Answer `yes`. + +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 so now: @@ -385,6 +388,9 @@ Now you can run the web server and background workers for asynchronous jobs: 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 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 From 387e37629b8647aeac27d5809a6b3412df5e945e Mon Sep 17 00:00:00 2001 From: John Skiles Skinner Date: Wed, 27 Mar 2024 17:24:24 -0700 Subject: [PATCH 3/3] Clarify local development context --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ec38fb4d..d806c7542 100644 --- a/README.md +++ b/README.md @@ -278,7 +278,9 @@ in the command line by using this command: ```sh 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. +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_