Skip to content
This repository has been archived by the owner on Jun 6, 2022. It is now read-only.

InsolvencyService/rps-alpha

Repository files navigation

rps-alpha build status

Follow these steps to setup a Quickstart development environment for working with the RPS Alpha project.

Quickstart Steps

Windows Pre-reqs

Mac Pre-reqs

As above, use Mac version.

Ubuntu pre-reqs

sudo aptitude install git
# Download vagrant deb package from http://downloads.vagrantup.com/
sudo dpkg -i vagrant.deb

Post Install Tasks

  • Configure SSH for GIT - Follow this guide (https://help.github.com/articles/generating-ssh-keys)
    • OK not to bother with a passphrase for alpha (leave blank), will need one for beta
  • Clone the repository.
    • cd to your work in progress folder in git-bash
    • From git-bash: git clone git@github.com:InsolvencyService/rps-alpha.git

Build box, run tests

  • Open a new git-bash (windows)/terminal (mac) on and navigate to where you have downloaded or cloned this repo.
  • Run vagrant up... Vagrant should create a new virtual machine and puppet should install all the needed deps.
  • Run vagrant ssh to ssh into the newly created virtual machine
  • Run cd /vagrant to see the files mirrored from your host machine to your VM
  • To get the project to run, you'll need to do the following
    • ./create_venv.sh
    • workon rps
    • cd rps/
  • You should now be able to:
    • run ./run_tests.sh to run the tests,
    • run./redundancy_payments_service --debug to run the claimant journey
    • run./insolvency_practitioner_app --debug to run the insolvency practitioner's journey
  • Once the server is running, you can access the webpage on http://localhost:8000/

More info

  • From within your vagrant box, cd to /vagrant/manual
  • pip install sphinx
  • Run make html
  • Open docs in your browser from: rps-alpha/manual/_build/html/index.html