Send money to someone in prison
Public-facing site for Prisoner Money suite of apps.
- Unix-like platform with Python 3.6+ and NodeJS 10 (e.g. via nvm)
It's recommended that you use a python virtual environment to isolate each application.
The simplest way to do this is using:
python3 -m venv venv # creates a virtual environment for dependencies; only needed the first time . venv/bin/activate # activates the virtual environment; needed every time you use this app
Some build tasks expect the active virtual environment to be at
/venv/, but should generally work regardless of
You can copy
local.py to overlay local settings that won't be committed,
but it’s not required for a standard setup.
In order to run the application locally, it is necessary to have the API running. Please refer to the money-to-prisoners-api repository.
Once the API has started locally, run
./run.py serve # or ./run.py start
All build/development actions can be listed with
./run.py --verbosity 2 help.
In order to run a server that's exactly similar to the production machines, you need to have Docker installed. Run
and you should be able to connect to the local server.
./run.py command, you can run a browser-sync server, and get the assets
to automatically recompile when changes are made, run
./run.py serve instead of
./run.py start. The server is then available at the URL indicated.
Runs all the application tests.
You can connect a local version of money-to-prisoners-common for development by pre-pending the following task to the run script.
python_dependencies --common-path [path]
Update translation files with
./run.py make_messages – you need to do this every time any translatable text is updated.
Pull updates from Transifex with
./run.py translations --pull.
You'll need to update translation files afterwards and manually check that the merges occurred correctly.
Push latest English to Transifex with
./run.py translations --push.
NB: you should pull updates before pushing to merge correctly.
This is handled by money-to-prisoners-deploy.
Additional Bespoke Packages
There are several dependencies of the
money-to-prisoners-send-money python library which are maintained by this team, so they may require code-changes when the dependencies (e.g. Django) of the
money-to-prisoners-send-money python library are incremented.
- django-form-error-reporting: https://github.com/ministryofjustice/django-form-error-reporting
- django-zendesk-tickets: https://github.com/ministryofjustice/django-zendesk-tickets
- django-moj-irat: https://github.com/ministryofjustice/django-moj-irat