notifications-admin/README.md

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

Languages needed

• Python 3
• Node 5.0.0 or greater

    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. To install virtualenv, run

    [sudo] pip install virtualenv

Make a virtual environment for this app:

    mkvirtualenv -p /usr/local/bin/python3 notifications-admin

Install dependencies and build the frontend assets:

    ./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

Running the application

    workon notifications-admin
    ./scripts/run_app.sh

Then visit localhost:6012