mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-27 13:51:12 -05:00
9fe66d6866
The page where you switch on the feature --- This content aims to describe: - the benefit of basic view – ‘make Notify quicker and simpler’ - who it benefits – ‘team members who only need to send messages’ - how it does it – ‘by hiding…’ - what it prevents users from being able to do or see – ‘everything except…’ - what it allows users to do – ‘send messages’, [see] ‘templates, a list of sent messages’ I’m still keen to mention sent messages here, as it feels weird not to mention it at all when it’s 1 of only 2 options in Basic view. I don’t think it’s as important to mention it on the Edit team member screen. I’ve specifically used ‘a list of sent messages’ rather than just ‘sent messages’, to make it seem less like a noun (new feature). The page where you choose whether someone has basic view --- Switches the focus from what you can see to what you can’t. Aims to be consistent with both: - the description of permissions in admin view - the language used to describe basic view in settings
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