Ryan Ahearn 2582dcccfb Merge branch 'main' into tdlowden-guidance
* main: (21 commits)
  Expect sms 2nd factor codes to be 6 digits
  Bump werkzeug from 2.2.2 to 2.2.3
  Switch egress proxy to official repo
  Run pipenv update
  Pin openpyxls to avoid bug between 3.1 and pyexcel-xlsx
  Bump cryptography from 39.0.0 to 39.0.1
  Remove direct use of aws creds from deployed environments
  Add cf-cli version check to create_service_account
  Tweak tail & jq usage to parse cf-cli@8 output
  Load New Relic in manifest.yml startup command
  Document how to retrieve NEW_RELIC_LICENSE_KEY for dev
  Use main notifications-utils branch again
  Remove wildcard matcher on egress allow
  Update proxy settings to enable sending data to new relic
  Updates for sandbox env
  Fix header test
  Configure egress proxy for new relic integration
  Add newrelic to browser CSP directives
  Validate new relic config in github actions
  Report data to newrelic
  ...
2023-02-21 11:10:34 -05:00
2023-01-05 21:55:07 -05:00
2022-11-08 09:44:52 -05:00
2022-11-28 15:53:56 -05:00
2022-12-14 13:30:46 -05:00
2022-11-07 11:29:20 -05:00
2023-01-23 10:00:03 -05:00
2023-01-23 10:00:03 -05:00
2023-02-16 07:35:35 +00:00

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

If you are using VS Code, there are also instructions for running inside Docker

  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

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

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 GSAs 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.

Were 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.

Description
The UI of Notify.gov
Readme 545 MiB
Languages
Python 69.3%
HTML 16.6%
JavaScript 11.1%
SCSS 0.9%
Nunjucks 0.7%
Other 1.4%