US Notify API

This project is the core of Notify. It's cloned from the brilliant work of the team at GOV.UK Notify, cheers!

This repo contains:

• A public-facing REST API for Notify, which teams can integrate with using API clients built by UK
• An internal-only REST API built using Flask to manage services, users, templates, etc., which the admin UI talks to)
• Asynchronous workers built using Celery to put things on queues and read them off to be processed, sent to providers, updated, etc.

Our other repositories are:

• notifications-admin
• notifications-utils
• us-notify-compliance
• notify-python-demo

Documentation, here and elsewhere

About Notify

• Roadmap
• Using the API

Infrastructure

• Overview, setup, and onboarding
• Database management
• Celery queues and tasks

Common dev work

• Local setup
• Testing, both automated and manual
• Deploying
• Running one-off tasks

UK docs that may still be helpful

• Writing public APIs
• Updating dependencies

Local setup

Direct installation

1. Set up Postgres && Redis on your machine

2. Install pipenv

3. Create the .env file

   cp sample.env .env
   # follow the instructions in .env
   

4. Run the project setup

   make bootstrap

5. Run the web server and background worker

   make run-procfile

6. Or run them individually:

   • Run Flask (web server)

     make run-flask

   • Run Celery (background worker)

     make run-celery

VS Code && Docker installation

If you're working in VS Code, you can also leverage Docker for a containerized dev environment

1. Create the .env file

   cp sample.env .env
   # follow the instructions in .env
   

2. Install the Remote-Containers plug-in in VS Code

3. With Docker running, create the network:

   docker network create notify-network

4. Using the command palette (shift+cmd+p) or green button thingy in the bottom left, search and select “Remote Containers: Open Folder in Container...” When prompted, choose devcontainer-api folder (note: this is a subfolder of notifications-api). This will start the container in a new window, replacing the current one.

5. Wait a few minutes while things happen 🍵

6. Open a VS Code terminal and run the Flask application:

   make run-flask

7. Open another VS Code terminal and run Celery:

   make run-celery

NOTE: when you change .env in the future, you'll need to rebuild the devcontainer for the change to take effect. VS Code should detect the change and prompt you with a toast notification during a cached build. If not, you can find a manual rebuild in command pallette or just docker rm the notifications-api container.

License && public domain

Work through commit e604385 is licensed by the UK government under the MIT license. Work after that commit is in the worldwide public domain. See LICENSE.md for more information.

Contributing

As stated in CONTRIBUTING.md, all contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.