mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-07-11 05:43:52 -04:00
5794a54385
‘Caseworker’ was a bad name because it: - suggested that Notify might be expanding into case management - may or may not map to someone’s actual role, in a confusing way (this is why ‘manager’ is also a bad name) ‘Basic view’ is the best name we could come up with because: - it describes the purpose of feature, not the user - a ‘view’ changes what you can _see_ as much as it changes what you can do Admin remains a good word – in research users self-describe their use of Notify in using it. This commit makes the name ‘admin view’ to match ‘basic view’. This also means we can hide the legend for this fieldset because the choices are self-explanatory.
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