LandRegistry/devenv-casework

Name: devenv-casework

Owner: HM Land Registry

Description: Test development environment for LR casework team

Created: 2015-05-08 00:50:16.0

Updated: 2015-06-11 16:26:52.0

Pushed: 2015-10-29 11:24:52.0

Homepage: null

Size: 340

Language: Shell

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

devenv-casework

Early development environment for the Digital by Default Casework project.

About

This development environment is designed to be easy to use, and function very similarly to a server environment.

Requirements:

• Vagrant < 1.4
• Virtualbox < 4.3.20

TL;DR

Inside the project folder, simply run vagrant up and then connect to your projects on the ports defined in configuration.yaml

Useful commands

All the apps are run by supervisord, here are some helpful aliases for supervisorctl.

us                - view running status of all apps (via supervisorctl)
 {name of app}    - stop app running in supervisord
t {name of app}   - start app running in supervisord
art {name of app} - restart app running in supervisord
ad                - reload supervisord config and restart all apps
tsup              - start supervisord (needed after a vagrant halt/vagrant up)

To run the app in the terminal (i.e. not via supervisord, so you can directly see the output)

un {name of app}

To quickly view the logs of an app

og {name of app}

Apps

Cases API:

localhost:5001

• GET POST /cases
• GET /cases/<caseid>

Cases Frontend:

localhost:5002

• /cases
• /cases/<casenumber>

Register Metadata

localhost:5003

• GET /mdref/<md_ref>

Update Register

localhost:5004

• POST /titles - Add whole working register.
• GET /titles/<title_number> - Get whole working register.
• POST /titles/<title_number>/groups/<group_position>/entries/<entry_position> - Amend an individual entry.
• PUT /titles/<title_number>/groups/<group_position>/entries/ - Insert an entry.
• DELETE /titles/<title_number>/groups/<group_position>/entries/<entry_position> - Delete an entry.
• GET /entrystructure/ - Get entry structure.
• PUT /titles/<title_number>/groups - Insert a group.
• DELETE /titles/<title_number>/groups/<group_position> - Delete a group.
• POST /titles/<title_number>/groups/<group_position> - Amend a group.

Titles API:

localhost:5005

• GET /validate/<title_number>

Auto Process Charge

localhost:5006

• POST /process/

Daylist Adapter:

localhost:8888/DaylistAdapter

• POST /cases/<title_number>

Titles Adapter:

localhost:8888/TitlesAdapter

• POST /titles/<title_number>

Notes

The development environment relies on Vagrant. Currently only Virtualbox is supported as a provider.

For further information on managing Vagrant you can read the official documentation.

TIP: You can improve the start-up time of the development environment by installing the cachier Vagrant plugin.

You can install it by running:

grant plugin install vagrant-cachier

How to query the postgres database with PSQL

Login to the centos virtual machine. Switch to root with:

 -i

login to the system of record database with this:

 -U workingregister workingregister