mirror of https://github.com/GSA/notifications-admin.git synced 2026-02-05 10:53:28 -05:00

Files

Chris Hill-Scott 5ebeec08ae Use a Node-based tools for handling assets

…or how to move a bunch of things from a bunch of different places into
`app/static`.

There are three main reasons not to use Flask Assets:
- It had some strange behaviour like only
- It was based on Ruby SASS, which is slower to get new features than libsass,
  and meant depending on Ruby, and having the SASS Gem globally installed—so
  you’re already out of being a ‘pure’ Python app
- Martyn and I have experience of doing it this way on Marketplace, and we’ve
  ironed out the initial rough patches

The specific technologies this introduces, all of which are Node-based:
- Gulp – like a Makefile written in Javascript
- NPM – package management, used for managing Gulp and its related dependencies
- Bower – also package management, and the only way I can think to have
  GOV.UK template as a proper dependency

…speaking of which, GOV.UK template is now a dependency. This means it can’t be
modified at all (eg to add a global `#content` wrapper), so every page now
inherits from a template that has this wrapper. But it also means that we have a
clean upgrade path when the template is modified.

Everything else (toolkit, elements) I’ve kept as submodules but moved them to a
more logical place (`app/assets` not `app/assets/stylesheets`, because they
contain more than just SASS/CSS).

2016-01-05 13:12:35 +00:00

1.5 KiB

Raw Blame History

notifications-admin

Application to handle the admin functions of the notifications application.

Features of this application:

Register users
Register services
Download CSV for an email or sms batch
Show history of notifications
Reports

Create a virtual environment for this project

    mkvirtualenv -p /usr/local/bin/python3 notifications-admin

Building the frontend

You need Node which will also get you NPM, Node's package management tool.

    brew install node

Most of the frontend dependencies are managed using Git Submodules. Some are managed with NPM and Bower. To install or update all the things, run

    git submodule init --update
    npm install

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

Running the application:

    pip install -r requirements.txt
    ./scripts/bootstrap.sh  
    ./scripts/run_app.sh

Note: the ./scripts/bootstrap.sh script only needs to be run the first time to create the database.

URL to test app:

localhost:6012/helloworld

Domain model

All the domain models are defined in the models.py file.

1.5 KiB Raw Blame History