From 9f21018d8e3c19db03eb7aa2aaabfcdd57c36105 Mon Sep 17 00:00:00 2001 From: Ben Klaas Date: Fri, 5 Aug 2022 02:22:21 +0000 Subject: [PATCH 1/2] Update QUICKSTART --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 3b04abc38..e1da43d8f 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,34 @@ make run-flask # Open another terminal and run the background tasks make run-celery ``` +## QUICK START +--- +If you are the first on your team to deploy, set up AWS SES/SNS as instructed in the AWS setup section below. +Create .env file as described in the .env section below. + +Install VS Code +Open VS Code and install the Remote-Containers plug-in from Microsoft. + +Make sure your docker daemon is running (on OS X, this is typically accomplished by opening the Docker Desktop app) + +Create the external docker network: + +`docker network create notify-network` + +Using the command palette (shift+cmd+p), search and select “Remote Containers: Open Folder in Container...” +When prompted, choose **devcontainer-api** folder (note: this is a *subfolder* of notification-api). This will startup the container in a new window (replacing the current one). + + +After this page loads, hit "show logs” in bottom-right. The first time this runs it will need to build the Docker image, which will likely take several minutes. + +Select View->Open View..., then search/select “ports”. Await a green dot on the port view, then open a new terminal and run the web server +`make run-flask` + +Open another terminal and run the background tasks +`make run-celery` + +--- ## Setting Up ### `.env` file From b32585d20d8894762b3c563fc1bf58ed1e88fd65 Mon Sep 17 00:00:00 2001 From: Ben Klaas Date: Fri, 5 Aug 2022 02:34:29 +0000 Subject: [PATCH 2/2] Remove old QUICKSTART --- README.md | 30 +++--------------------------- 1 file changed, 3 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index e1da43d8f..d93cfd0e9 100644 --- a/README.md +++ b/README.md @@ -8,30 +8,7 @@ Contains: - an internal-only REST API built using Flask to manage services, users, templates, etc (this is what the [admin app](http://github.com/18F/notifications-admin) talks to) - asynchronous workers built using Celery to put things on queues and read them off to be processed, sent to providers, updated, etc - -## QUICK START -``` -# If you are the first on your team to deploy, set up AWS SES/SNS as instructed below - -# create .env file as instructed below - -# download vscode and install the Remote-Containers plug-in from Microsoft - -# make sure your docker daemon is running - -# create the external docker network -docker network create notify-network - -# Using the command pallette (cmd+p), search "Remote Containers: Open folder in project" -# choose devcontainer-api folder, after reload, hit "show logs" in bottom-right - -# Check vscode panel > ports, await green dot, open a new terminal and run the web server -make run-flask - -# Open another terminal and run the background tasks -make run-celery -``` -## QUICK START +## QUICKSTART --- If you are the first on your team to deploy, set up AWS SES/SNS as instructed in the AWS setup section below. @@ -49,13 +26,12 @@ Create the external docker network: Using the command palette (shift+cmd+p), search and select “Remote Containers: Open Folder in Container...” When prompted, choose **devcontainer-api** folder (note: this is a *subfolder* of notification-api). This will startup the container in a new window (replacing the current one). - After this page loads, hit "show logs” in bottom-right. The first time this runs it will need to build the Docker image, which will likely take several minutes. -Select View->Open View..., then search/select “ports”. Await a green dot on the port view, then open a new terminal and run the web server +Select View->Open View..., then search/select “ports”. Await a green dot on the port view, then open a new terminal and run the web server: `make run-flask` -Open another terminal and run the background tasks +Open another terminal and run the background tasks: `make run-celery` ---