mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-05 19:03:30 -05:00
eaf1534e9a
Some time between version 6.32 and 6.34 of the Cloudfoundry CLI the ability to redirect the output of a command into `cf push -f` was broken. The only alternative we can think of is writing the file to disk, doing the deploy, and then deleting it. We’re careful to write to a directory outside the current repo to avoid: - including secrets in the deployed package - accidentally checking the secrets into source control `/tmp/` seems to be a good place to put it, since, even if the delete doesn’t run, it will get cleaned up eventually (probably when the machine next boots). Right now this only applies to people deploying from their local machines. At some point it will affect Jenkins too, but isn’t now. So this commit only fixes the problem for the commands that developers run locally. fixup! Write manifests to disk instead of redirecting
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