Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ministryofjustice/money-to-prisoners-noms-ops
Prisoner Money Intelligence – Security staff facing site for Prisoner Money suite of apps
https://github.com/ministryofjustice/money-to-prisoners-noms-ops
hmpps mtp
Last synced: about 1 month ago
JSON representation
Prisoner Money Intelligence – Security staff facing site for Prisoner Money suite of apps
- Host: GitHub
- URL: https://github.com/ministryofjustice/money-to-prisoners-noms-ops
- Owner: ministryofjustice
- License: mit
- Created: 2015-09-03T09:10:08.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-06-04T09:31:50.000Z (4 months ago)
- Last Synced: 2024-06-04T10:51:00.103Z (4 months ago)
- Topics: hmpps, mtp
- Language: Python
- Homepage:
- Size: 2.35 MB
- Stars: 3
- Watchers: 33
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Prisoner Money Intelligence – Prisoner Money
Security staff facing site for [Prisoner Money suite of apps](https://github.com/ministryofjustice/money-to-prisoners).
## Requirements
- Unix-like platform with Python 3.10 and NodeJS 20 (e.g. via [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) or [fnm](https://github.com/Schniz/fnm#installation))
## Running locally
It’s recommended that you use a python virtual environment to isolate each application.
The simplest way to do this is using:
```shell
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
its location.
You can copy `mtp_noms_ops/settings/local.py.sample` to `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](https://github.com/ministryofjustice/money-to-prisoners-api/) repository.
Once the API has started locally, run
```shell
./run.py serve
# or
./run.py start
```
This will build everything and run the local server at [http://localhost:8003/](http://localhost:8003/).
The former also starts browser-sync at [http://localhost:3003/](http://localhost:3003/).
You should be able to login using following credentials: `security-staff` or `prison-security`
All build/development actions can be listed with `./run.py --verbosity 2 help`.
### Alternative: Docker
In order to run a server that’s exactly similar to the production machines,
you need to have [Docker](https://www.docker.com/products/developer-tools) installed. Run
```shell
./run.py local_docker
```
and you should be able to connect to the local server.
## Developing
[](https://circleci.com/gh/ministryofjustice/money-to-prisoners-noms-ops)
With the `./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.
```shell
./run.py test
```
Runs all the application tests.
You can connect a local version of [money-to-prisoners-common](https://github.com/ministryofjustice/money-to-prisoners-common/)
for development by pre-pending the following task to the run script.
```shell
python_dependencies --common-path [path]
```
### Translating
Update translation files with `./run.py make_messages` – you need to do this every time any translatable text is updated.
Requires [transifex cli tool](https://github.com/transifex/cli#installation) for synchronisation:
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.
## Deploying
This is handled by [money-to-prisoners-deploy](https://github.com/ministryofjustice/money-to-prisoners-deploy/).
## Additional Bespoke Packages
There are several dependencies of the ``money-to-prisoners-noms-ops`` 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-noms-ops`` python library are incremented.
* django-zendesk-tickets: https://github.com/ministryofjustice/django-zendesk-tickets
* django-moj-irat: https://github.com/ministryofjustice/django-moj-irat