notifications-admin/README.md

Notify UI

This is the Notify front-end for government users and admins. To see it in action, check out the demo site (contact team for credentials).

Through the interface, users can:

• Register and manage users
• Create and manage services
• Send batch SMS by uploading a CSV
• View their history of notifications

The Notify API provides the UI's backend and is required for most things to function. Set that up first!

Local setup

Direct setup

1. Get the API running

2. Install pipenv

3. Install Python and Node dependencies

   make bootstrap

4. Create the .env file

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

5. Run the Flask server

   make run-flask

6. Go to http://localhost:6012

VS Code && Docker installation

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

1. Get the API running, including the Docker network

2. Create the .env file

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

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

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-admin folder (note: this is a subfolder of notifications-admin). 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. Go to http://localhost:6012

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.

To test the application

From a terminal within the running devcontainer:

# run all the tests
make test

# continuously run js tests
npm run test-watch

To run a specific JavaScript test, you'll need to copy the full command from package.json.

Running a11y-scans locally

Unlike most of the tests and scans, pa11y-ci cannot currently be run from within the VSCode dev container.

1. Run make run-flask from within the devcontainer
2. Run make a11y-scan from your host computer.

Further docs from UK

• Working with static assets
• JavaScript documentation
• Updating dependencies

License && public domain

Work through commit 543be77 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.

About the TTS Public Benefits Studio

The Public Benefits Studio is a team inside of GSA’s Technology Transformation Services (TTS), home to innovative programs like 18F and Login.gov. We collaborate with benefits programs to develop shared technology tools and best practices that reduce the burden of navigating government programs for low income individuals and families.

We’re a cross-functional team of technologists with specialized experience working across public benefits programs like Medicaid, SNAP, and unemployment insurance.

For more information on what we're working on, the Notify tool, and how to get involved with our team, see our flyer.