Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 2.53 KB

README.md

File metadata and controls

74 lines (46 loc) · 2.53 KB
Raw

smartstart-backend

SmartStart provides step-by-step information and support to help users access the right services for them and their baby.

This repository is the back end. It uses Django, Django REST Framework and RealMe. There is a separate repository for smartstart-frontend, a React JavaScript user interface.

Development environments

If you are a Catalyst developer, please see the instructions for environment setup, and the section below regarding RealMe bundles.

First time set up

The following instructions assume you are on a Ubuntu Linux system.

Clone this repository to a directory and use the requirements.txt file to set up your Python 3.x virtual environment.

Set up settings by copying and editing the supplied local.py.example file:

cp settings/local.py.example settings/local.py
vi settings/local.py

Note that the Django SECRET_KEY setting is used everywhere for password hashing, CSRF tokens and session keys, among other things, so you should set it to be something unique.

Create a database in PostgreSQL and amend the DATABASES setting in local.py to reflect the required database access details, then use Django management commands to set up the database and load test users from the fixture:

python manage.py migrate --fake-initial
python manage.py loaddata test_users

The fixture contains two test users:

  • admin/admin
  • test/test

For development, the backend should now run with the Django runserver command:

python manage.py runserver 0.0.0.0:8000

Then you can view the site in a browser at:

http://127.0.0.1:8000

RealMe integration

This application relies on the RealMe service for authentication. If you are dealing with the live site (you are probably a Catalyst developer!) see the section below. Otherwise, please use the django-realme package.

Set up for MTS (Catalyst developers only)

Decrypt the GPG file for the RealMe MTS bundle; refer to bundles/README.md for details. Then make sure following settings are correct:

BUNDLE_NAME = 'MTS'
BUNDLES_ROOT = '/path/to/bundles'
SITE_URL = 'https://mts-test.dev.boac.lef'

Then go to this url:

/realme/metadata/

Save the XML in the resulting page as a text file somewhere, then upload it to:

https://mts.realme.govt.nz/logon-mts/metadataupdate

Note: after uploading, it just verifies the file, you need to click a second Import button to finally apply it.