b968c0299e
I recently found that there is a problem with the overuse of lists online for sequences of content that don't need to be in a list. I think that's what we're doing with our map key. The problem is large enough that browsers include heuristics to determine if lists should be presented as such to the accessibility API (and so to assistive tech' like screen readers). This thread contains more details: https://twitter.com/cookiecrook/status/1337226933822603270 Based on the metric described in the thread: 'If all of the styles that make it “list-like” have been removed, it’s no longer relevant to convey it as a list.' ...or 'if a sighted user doesn’t need to know it’s a list, why would a screen reader user need to know or want to know?' Based on that, I think the items in our map key should be paragraphs, not items in a list. Also, they read really well as sentences when announced by a screen reader, partly because of the extra (hidden) info @quis added to them. This also doesn't change their visual appearance.
notifications-admin
GOV.UK Notify admin application - https://www.notifications.service.gov.uk/
- Register and manage users
- Create and manage services
- Send batch emails and SMS by uploading a CSV
- Show history of notifications
Setting up
Python version
At the moment we run Python 3.6 in production.
NPM packages
brew install node
NPM is Node's package management tool. n is a tool for managing different versions of Node. The following installs n and uses the long term support (LTS) version of Node.
npm install -g n
n lts
environment.sh
In the root directory of the application, run:
echo "
export NOTIFY_ENVIRONMENT='development'
export FLASK_APP=application.py
export FLASK_ENV=development
export WERKZEUG_DEBUG_PIN=off
"> environment.sh
AWS credentials
To run parts of the app, such as uploading letters, you will need appropriate AWS credentials. See the Wiki for more details.
To run the application
# install dependencies, etc.
make bootstrap
# run the web app
make run-flask
Then visit localhost:6012.
Any Python code changes you make should be picked up automatically in development. If you're developing JavaScript code, run npm run watch to achieve the same.
To test the application
# install dependencies, etc.
make bootstrap
# 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.
To update application dependencies
requirements.txt is generated from the requirements.in in order to pin versions of all nested dependencies. If requirements.in has been changed, run make freeze-requirements to regenerate it.