Skip to content

CAIT - Child Arrangements Informational Tool v2 (Ruby)

License

Notifications You must be signed in to change notification settings

ministryofjustice/help-with-child-arrangements

Repository files navigation


MoJ logo

Help With Child Arrangements

repo standards badge

Private Family Law - Child Arrangements Information Tool

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/help-with-child-arrangements.git
$ cd help-with-child-arrangements

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.

Assets

Yarn and node are required to build css and js assets

$ brew install node
$ brew install yarn
$ yarn install

Setup

Use the setup command to install gems

$ bin/setup

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

Exceptions

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