Skip to content
Send emails and text messages to your users if you work in Australian government
Python HTML Ruby CSS JavaScript Makefile Other
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci celery: use SQS backend Feb 27, 2020
admin admin: fix use of government in content Feb 26, 2020
api celery: use SQS backend Feb 27, 2020
ci ci: cleanup old apps, add TODO note Feb 27, 2020
docs docs: fix active lang tab style on initial load Jul 26, 2019
status status: bump nokogiri from 1.10.5 to 1.10.8 Feb 26, 2020
utils all: upgrade bleach to 3.1.1 Feb 25, 2020
.gitignore Excluding Intellij files Aug 20, 2018
Makefile celery: use SQS backend Feb 27, 2020
README.md celery: use SQS backend Feb 27, 2020

README.md

Notify

Notify is a service developed by the Digital Transformation Agency that helps government agencies communicate with their users.

This is the open source repository that encompasses all projects that make up Notify.

Running the things

We can orchestrate all of these projects by using a set of common Makefile conventions.

The targets that every sub-project should implement are:

  • install
  • install-dev
  • build
  • test
  • clean
  • deploy
  • deploy-dev
  • check-vulnerabilities

Issuing any of these commands at the root level will forward it on to all sub-projects. For example, you can set up and build every project by running

make install
make build

You can run all the tests of all projects by running

make install-dev
make test

You can also work with a specific project from the root level by prefixing the command with the project name, and a full stop separator.

For instance, running the API in dev mode is done with

make api.run

Alternatively, you can change into the api directory and issue the make run command directly.

To start the whole app from nothing, you'll need to run the following in different shells.

make api.run-celery-worker-sender
make api.run-celery-worker
make admin.run

... then hit up http://localhost:6012 to get going.

Optionally you can also run this target to run the scheduled tasks:

make api.run-celery-beat

Requirements

Different projects have different needs. Consult them individually to be sure.

Generally though, you'll need Python and pipenv for the frontend and backend.

You'll need Node.js for the frontend and docs,

And we've got a simple open source status page that's written in Ruby, but we don't usually run it locally.

Credits

Notify is based on GOV.UK Notify.

Thanks GDS team for providing Notify as an open source project that made it possible for us to build on a stable and reliable foundation.

You can’t perform that action at this time.