darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-09-07 15:58:25 -04:00
Code Issues Packages Projects Releases Wiki Activity

Tidy up README

Browse Source
This commit is contained in:
Henry Hadlow
2016-02-03 15:18:57 +00:00
parent 9bdce7007d
commit b1eadaedcd
1 changed files with 27 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@@ -3,24 +3,18 @@
# notifications-admin # notifications-admin
Application to handle the admin functions of the notifications application. Application to handle the admin functions of the notifications application.
### Features of this application: ## Features of this application
<ul>
<li>Register users
<li>Register services
<li>Download CSV for an email or sms batch
<li>Show history of notifications
<li>Reports
</ul>
### Create a virtual environment for this project - Register users
```shell - Register services
mkvirtualenv -p /usr/local/bin/python3 notifications-admin - Download CSV for an email or SMS batch
``` - Show history of notifications
- Reports
## First-time setup
### Building the frontend
You need [Node](http://nodejs.org/) which will also get you [NPM](npmjs.org), You need [Node](http://nodejs.org/) which will also get you [NPM](npmjs.org),
Node's package management tool. Node's package management tool.
@@ -43,28 +37,36 @@ The frontend dependencies are managed using NPM and Bower. To install or update
npm run build npm run build
``` ```
The app runs within a virtual environment. To [install virtualenv](https://virtualenv.readthedocs.org/en/latest/installation.html), run
```shell
[sudo] pip install virtualenv
```
To make a virtualenv for this app, run
```shell
mkvirtualenv -p /usr/local/bin/python3 notifications-admin
pip install -r requirements.txt
./scripts/bootstrap.sh
```
## Building the frontend
If you want the front end assets to re-compile on changes, leave this running If you want the front end assets to re-compile on changes, leave this running
in a separate terminal from the app in a separate terminal from the app
```shell ```shell
npm run watch npm run watch
``` ```
### Running the application: ## Running the application
```shell ```shell
pip install -r requirements.txt workon notifications-admin
./scripts/bootstrap.sh
./scripts/run_app.sh ./scripts/run_app.sh
``` ```
Note: the ./scripts/bootstrap.sh script only needs to be run the first time to Then visit [localhost:6012](localhost:6012)
create the database.
URL to test app: ## Domain model
localhost:6012/helloworld
### Domain model
All the domain models are defined in the All the domain models are defined in the
[models.py](https://github.com/alphagov/notifications-admin/blob/master/app/models.py) [models.py](https://github.com/alphagov/notifications-admin/blob/master/app/models.py)