Skip to content

ministryofjustice/find-unclaimed-court-money

Repository files navigation


MoJ logo

Find Unclaimed Court Money

repo standards badge

An application that enables searches for unclaimed court money. Also allows admins to upload a CSV of the latest data.

Development

Working on the Code

Work should be based off of, and PRed to, the main branch. We use the GitHub PR approval process so once your PR is ready you'll need to have one person approve it, and the CI tests passing, before it can be merged.

Basic Setup

Cloning This Repository

Clone this repository then cd into the new directory

$ git clone git@github.com:ministryofjustice/find-unclaimed-court-money.git
$ cd find-unclaimed-court-money

Installing the app for development

Latest Version of Ruby

If you don't have rbenv already installed, install it as follows:

$ brew install rbenv ruby-build

Use rbenv to install the latest version of ruby as defined in .ruby-version (make sure you are in the repo path):

$ rbenv install
$ rbenv init
$ rbenv rehash

Follow the instructions printed out from the rbenv init command and update your ~/.bash_profile or equivalent file accordingly, then start a new terminal and navigate to the repo directory.

Database Setup

The application uses postgresql

$ brew install postgresql

Use the setup command to install gems and create the database with seed data

$ bin/setup

Assets

Yarn and node are required to build css and js assets

$ brew install node
$ brew install yarn
$ yarn install

Running locally

Use the dev command to run the application. This will use Foreman to start the rails server as well as compiling the css and js. Any changes to the css and js will be live updated.

$ bin/dev

Running tests

$ bundle exec rspec

Admin

The admin area is accessed via the path '/admin'. In production this is restricted to a set of allowed IP addresses which are stored in a secret in a semicolon delimited list.

Exceptions

Any exceptions raised in any deployed environment will be sent to Sentry.