mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-06 11:23:48 -05:00
82 lines
1.9 KiB
Markdown
82 lines
1.9 KiB
Markdown
# notifications-admin
|
|
|
|
GOV.UK Notify admin application - https://www.notifications.service.gov.uk/
|
|
|
|
- Register and manage users
|
|
- Create and manage services
|
|
- Send batch emails and SMS by uploading a CSV
|
|
- Show history of notifications
|
|
|
|
## Setting up
|
|
|
|
### Python version
|
|
|
|
At the moment we run Python 3.9 in production.
|
|
|
|
### NPM packages
|
|
|
|
```shell
|
|
brew install node
|
|
```
|
|
|
|
[NPM](npmjs.org) is Node's package management tool. `n` is a tool for managing different versions of Node. The following installs `n` and uses the long term support (LTS) version of Node.
|
|
|
|
```shell
|
|
npm install -g n
|
|
n lts
|
|
```
|
|
|
|
### `environment.sh`
|
|
|
|
In the root directory of the application, run:
|
|
|
|
```
|
|
echo "
|
|
export NOTIFY_ENVIRONMENT='development'
|
|
export FLASK_APP=application.py
|
|
export FLASK_ENV=development
|
|
export WERKZEUG_DEBUG_PIN=off
|
|
"> environment.sh
|
|
```
|
|
|
|
### AWS credentials
|
|
|
|
To run parts of the app, such as uploading letters, you will need appropriate AWS credentials. See the [Wiki](https://github.com/alphagov/notifications-manuals/wiki/aws-accounts#how-to-set-up-local-development) for more details.
|
|
|
|
## To run the application
|
|
|
|
```shell
|
|
# install dependencies, etc.
|
|
make bootstrap
|
|
|
|
# run the web app
|
|
make run-flask
|
|
```
|
|
|
|
Then visit [localhost:6012](http://localhost:6012).
|
|
|
|
Any Python code changes you make should be picked up automatically in development. If you're developing JavaScript code, run `npm run watch` to achieve the same.
|
|
|
|
## To test the application
|
|
|
|
```
|
|
# install dependencies, etc.
|
|
make bootstrap
|
|
|
|
# run all the tests
|
|
make test
|
|
|
|
# continuously run js tests
|
|
npm run test-watch
|
|
```
|
|
|
|
To run a specific JavaScript test, you'll need to copy the full command from `package.json`.
|
|
|
|
## To update application dependencies
|
|
|
|
`requirements.txt` is generated from the `requirements.in` in order to pin versions of all nested dependencies. If `requirements.in` has been changed, run `make freeze-requirements` to regenerate it.
|
|
|
|
## Further docs
|
|
|
|
- [Working with static assets](docs/static-assets.md)
|