dbc85fcc1f
We introduced the ‘breaking change’ page[1] partly to help teach people about the relationship between the placeholders in their template and the data they were providing. Data can be provided either by API or by uploading a spreadsheet. The users who we struggled to communicate this relationship to were the ones using the upload a spreadsheet feature. We made two changes to the context of this feature: 1. Around the same time we introduced the interactive tour[2], which ultimately proved to be the thing that helped people understand the relationship between the data they were providing and the placeholders in the template. 2. We introduced a way for people to send one-off messages without using the API or uploading a spreadsheet[3]. So for this page to say that you’ll need to update a spreadsheet or change an API call if you change the placeholders in your template is no longer accurate. Therefore I think it makes sense to only show this page to teams who are using the API to send messages. The best proxy we have for that is to look at whether they’ve created any API keys. *** 1. https://github.com/alphagov/notifications-admin/pull/631 2. https://github.com/alphagov/notifications-admin/pull/613 3. https://github.com/alphagov/notifications-admin/pull/1293
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 long term support (LTS)
version of Node.
npm install -g n
n lts
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
Updating application dependencies
requirements.txt file is generated from the requirements-app.txt in order to pin
versions of all nested dependencies. If requirements-app.txt has been changed (or
we want to update the unpinned nested dependencies) requirements.txt should be
regenerated with
make freeze-requirements
requirements.txt should be committed alongside requirements-app.txt changes.
Working with static assets
When running locally static assets are served by Flask at http://localhost:6012/static/…
When running on preview, staging and production there’s a bit more to it:
