mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-24 04:10:57 -05:00
457249c0fa
We’ve had a couple of instances where teams have sent the wrong template to a …number of users. Sometimes templates can be very similar and only have slight variations to tailor them to a specific subset of users. So identifying the right template by sight can be difficult. We know that teams do give their templates meaningful names, and use these names in other tools (spreadsheets etc) to refer to the templates. So putting the name of the template on the page where you’re about to send all the messages seems like it’s gives people an easier way of double checking that they’re doing the right thing. I umm’d and ahh’d over the wording a bit, and think ‘Preview of…’ reads the best. It looks a bit weird because most template names are Title Case. I think it’s better than some ambiguous punctuation (eg ‘Preview: Template name’ or ‘Template name – preview’). Some examples of real template names: - Preview of Example text message templates - Preview of Online LPA payment application reminder - Preview of Create user account - Preview of Split journey - Unknown credentials - Preview of Public user: application without supporting documents - Preview of Renewal Survey – February - Preview of CEX New adult - Preview of Applications are closing tomorrow - Preview of Your application result - if successful
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 imagemagick ghostscript cairo pango
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 ADMIN_CLIENT_SECRET='notify-secret-key'
export API_HOST_NAME='http://localhost:6011'
export DANGEROUS_SALT='dev-notify-salt'
export SECRET_KEY='notify-secret-key'
export DESKPRO_API_HOST="some-host"
export DESKPRO_API_KEY="some-key"
"> 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