mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-07-08 18:34:24 -04:00
1fba5d186d
In research I’ve sometimes seen people click the wrong nav item. I reckon that people’s concept of which pages live behind which navigation items isn’t very strong. We can reinforce this relationship by showing, for every page, which is the corresponding nav item. The conventional way of doing this is either with some kind of emphasis, typically colour or bold. I’ve gone for bold because colour would be weird. --- The implementation of this is quite loosely coupled to our application code because: - our application code is not well structured (eg we don’t make any use of blueprints) - spreading this change across lots of files in our application would make it harder to test without actually hitting each endpoints; such tests would be slow and verbose So I’ve gone for more of a meta approach. Rather than testing that each endpoint has a specific navigation item selected, I’ve gone for validating that: - all endpoints being mapped to are real - all endpoints have _a_ selected navigation item (or are specifically excluded) This means that it’s impossible to add, change or remove an endpoint without also updating which navigation item should be selected. And the actual mapping is so declarative that it testing it would be redundant.
notifications-admin
GOV.UK Notify admin application.
Features of this application
- Register and manage users
- Create and manage services
- Send batch emails and SMS by uploading a CSV
- Show history of notifications
First-time setup
Brew is a package manager for OSX. The following command installs brew:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Languages needed
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 latest
version of Node.
npm install -g n
n latest
npm rebuild node-sass
The app runs within a virtual environment. We use mkvirtualenv for easier working with venvs
pip install virtualenvwrapper
mkvirtualenv -p /usr/local/bin/python3 notifications-admin
Install dependencies and build the frontend assets:
workon notifications-admin
./scripts/bootstrap.sh
Rebuilding the frontend assets
If you want the front end assets to re-compile on changes, leave this running in a separate terminal from the app
npm run watch
Create a local environment.sh file containing the following:
echo "
export NOTIFY_ENVIRONMENT='development'
export FLASK_APP=application.py
export FLASK_DEBUG=1
export WERKZEUG_DEBUG_PIN=off
"> environment.sh
AWS credentials
Your aws credentials should be stored in a folder located at ~/.aws. Follow Amazon's instructions for storing them correctly
Running the application
workon notifications-admin
./scripts/run_app.sh
Then visit localhost:6012