A simple, user-friendly online service for citizens to submit pleas for summary motoring offences.

• VirtualBox
• Vagrant
• Docker & Docker-compose

NOTE: Vagrant or docker can be used to set up a local dev environment

Clone the repository:

git clone git@github.com:ministryofjustice/manchester_traffic_offences_pleas.git

Create your own local.py:

cp manchester_traffic_offences/settings/local.py.example make_a_plea/settings/local.py

vagrant up
vagrant ssh

The vagrant bootstrap script will install everything you need to run the application server. All you need to do is override the relevant email settings in your local.py.

Once you're ssh'd in run:

./manage.py runserver 0.0.0.0:8000

to run the development web server, and browse to http://localhost:8000 to see the server.

copy docker/sample-local-env to docker/local-env

run:

docker-compose up

This will install dependencies from requirements.txt but initial migrations will need to be run manually - see below.

Navigate to:

{ip of docker machine}:8000

To get an interactive prompt (needed to run migrations, etc.), run:

docker-compose run django /bin/bash

You can also run commands directly, e.g:

docker-compose run django ./manage.py migrate

Front-end development uses the gulp task runner.

Make sure you have nodejs installed, then run:

npm install

Completely removes the /make_a_plea/assets directory.

Creates /make_a_plea/assets/healthcheck.txt used for uptime stats.

Compiles all SASS source files to CSS stylesheets and sourcemaps into the /make_a_plea/assets/stylesheets and /make_a_plea/assets/maps directories.

Compiles all JavaScript modules and scripts to the /make_a_plea/assets/javascripts directories and copies over the vendor dependencies.

Runs JSLint on all non-dependencies source JavaScript files.

Runs the JavaScript modules tests. Configuration in karma.conf.js.

Optimises all image assets into /make_a_plea/assets/images.

Sets up a watch on a number of directories. When a file has been changed, the relevant tasks are then automatically run:

• For files in /make_a_plea/assets-src/stylesheets: sass task
• For files in /make_a_plea/assets-src/javascripts: lint, then js tasks
• For files in /make_a_plea/assets-src/images: images task

This is the default task, which can be run by simply using gulp. It runs the following tasks:

• clean
• healthcheck
• lint
• js
• images
• sass

Translations for the Welsh language are currently achieved using gettext and .po language files.

When content requiring translation has been added, the source English language .po file should be updated. To do so, run the makemessages script, which will update the .po file to include the latest source strings:

./makemessages.sh

It may then be necessary to manually find strings marked as fuzzy, and check the source string matches the translation string in all cases.

Once the file has been updated, it needs to be submitted to the relevant translation team, who should then provide an updated Welsh language .po file. Replace the existing /conf/locale/cy/LC_MESSAGES/django.po with this file, then compile the messages:

./manage.py compilemessages