darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-01 23:55:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Remove old QUICKSTART

Browse Source
This commit is contained in:
Ben Klaas
2022-08-05 02:34:29 +00:00
parent 9f21018d8e
commit b32585d20d
1 changed files with 3 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -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`
---