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

Merge pull request #222 from alphagov/bootstrap-front-end

Browse Source 
Add frontend install and build to bootstrap script
This commit is contained in:
NIcholas Staples
2016-03-03 11:03:09 +00:00
parent 1d9cace0e5 5b073341a0
commit a9b9927115
2 changed files with 19 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@@ -4,52 +4,49 @@
# notifications-admin # notifications-admin
Application to handle the admin functions of the notifications application. GOV.UK Notify admin application.
## Features of this application ## Features of this application
- Register users - Register and manage users
- Register services - Create and manage services
- Download CSV for an email or SMS batch - Send batch emails and SMS by uploading a CSV
- Show history of notifications - Show history of notifications
- Reports
## First-time setup ## First-time setup
You need [Node](http://nodejs.org/) which will also get you [NPM](npmjs.org), Languages needed
Node's package management tool. - Python 3
- [Node](http://nodejs.org/) 5.0.0 or greater
```shell ```shell
brew install node brew install node
``` ```
n is a tool for managing different versions of node. The following installs n [NPM](npmjs.org) is Node's package management tool. `n` is a tool for managing
and uses the latest version of node. different versions of Node. The following installs `n` and uses the latest
version of Node.
```shell ```shell
npm install -g n npm install -g n
n latest n latest
npm rebuild node-sass npm rebuild node-sass
``` ```
The frontend dependencies are managed using NPM and Bower. To install or update
*all the things*, run
```shell
npm install
npm run build
```
The app runs within a virtual environment. To [install virtualenv](https://virtualenv.readthedocs.org/en/latest/installation.html), run The app runs within a virtual environment. To [install virtualenv](https://virtualenv.readthedocs.org/en/latest/installation.html), run
```shell ```shell
[sudo] pip install virtualenv [sudo] pip install virtualenv
``` ```
To make a virtualenv for this app, run Make a virtual environment for this app:
```shell ```shell
mkvirtualenv -p /usr/local/bin/python3 notifications-admin mkvirtualenv -p /usr/local/bin/python3 notifications-admin
pip install -r requirements.txt ```
Install dependencies and build the frontend assets:
```shell
./scripts/bootstrap.sh ./scripts/bootstrap.sh
``` ```
## Building the frontend ## Rebuilding the frontend assets
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
@@ -64,10 +61,4 @@ in a separate terminal from the app
./scripts/run_app.sh ./scripts/run_app.sh
``` ```
Then visit [localhost:6012](localhost:6012) Then visit [localhost:6012](http://localhost:6012)
## Domain model
All the domain models are defined in the
[models.py](https://github.com/alphagov/notifications-admin/blob/master/app/models.py)
file.

2
scripts/bootstrap.sh
View File

@@ -27,3 +27,5 @@ fi
# Install Python development dependencies # Install Python development dependencies
pip3 install -r requirements_for_test.txt pip3 install -r requirements_for_test.txt
npm install && npm run build