mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-04 18:32:33 -05:00
Update README.md
This commit is contained in:
23
README.md
23
README.md
@@ -3,18 +3,19 @@ https://travis-ci.org/alphagov/notifications-admin.svg
|
|||||||
# 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:
|
||||||
Register users.
|
<ul>
|
||||||
Register services.
|
<li>Register users
|
||||||
Download CSV for an email or sms batch.
|
<li>Register services
|
||||||
Show history of notifications.
|
<li>Download CSV for an email or sms batch
|
||||||
Reports.
|
<li>Show history of notifications
|
||||||
|
<li>Reports
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
### Create a virtual environment for this project
|
||||||
Create a virtual environment for this project
|
|
||||||
mkvirtualenv -p /usr/local/bin/python3 notifications-admin
|
mkvirtualenv -p /usr/local/bin/python3 notifications-admin
|
||||||
|
|
||||||
GOV.UK frontend toolkit
|
### GOV.UK frontend toolkit
|
||||||
The GOV.UK frontend toolkit is a submodule of this project.
|
The GOV.UK frontend toolkit is a submodule of this project.
|
||||||
To get the content of the toolkit run the following two commands
|
To get the content of the toolkit run the following two commands
|
||||||
|
|
||||||
@@ -22,6 +23,6 @@ GOV.UK frontend toolkit
|
|||||||
git submodule update
|
git submodule update
|
||||||
|
|
||||||
|
|
||||||
To run the sample application run:
|
### To run the sample application run:
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
python app.py
|
python app.py
|
||||||
|
|||||||
Reference in New Issue
Block a user