mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-28 06:11:03 -05:00
44a0845882
In research we found that developers orientate themselves around the API clients rather than the documentation. We should get them to the client documentation as quickly as possible. We currently link to the API documentation in three places: - API integration page - global footer - template ‘API info’ page For the first two this commit: - removes the link to the documentation - adds links to each of the 5 clients For the last one it just removes the link entirely.
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
Create a local environment.sh file containing the following:
echo "
export NOTIFY_ENVIRONMENT='development'
export ADMIN_CLIENT_SECRET='dev-notify-secret-key'
export ADMIN_CLIENT_USER_NAME='dev-notify-admin'
export API_HOST_NAME='http://localhost:6011'
export DANGEROUS_SALT='dev-notify-salt'
export SECRET_KEY='dev-notify-secret-key'
export DESKPRO_API_HOST=""
export DESKPRO_API_KEY=""
export DESKPRO_DEPT_ID=""
export DESKPRO_ASSIGNED_AGENT_TEAM_ID=""
"> environment.sh
Running the application
workon notifications-admin
./scripts/run_app.sh
Then visit localhost:6012