Skip to content

UKHomeOffice/pttg-ip-fm-ui

Repository files navigation

Income Proving Family Migration UI

pttg-ip-fm-ui

Docker Repository on Quay

##Overview

This is the Income Proving UI. It consists of 2 pages; a Search page and a Results page.

This UI gathers the migrant(s) details and displays the appropriate calculated result.

This service talks with HMRC via pttg-ip-api to match an individual(s), retrieve incomes and employments and calculates if a migrant has sufficient income to support themselves and any associated dependants during their time in the UK. Data entered by the user defines how much data is considered for the calculation and the threshold income amount which should be applied to this data.

Technical Notes

The UI is implemented using Angular v1 on Node.Js.

Building

This service is built using Node JS on Drone using Drone yaml.

Infrastructure

This service is packaged as a Docker image and stored on Quay.io

This service is deployed by Drone onto a Kubernetes cluster running on the ACP platform using its Kubernetes configuration

Running Locally

This assumes that node and npm are installed locally.

  • Check out the project and run command npm run init to install dependencies
  • Run command npm run build to build the project
  • Run command npm start to start the UI

The UI should be available at localhost:8000 (which is defined in server as variable port).

Note that the UI needs a back-end to talk to, which is provided by pttg-ip-api. The location of the back-end is defined in server in variable apiRoot, which should be the default server port in pttg-ip-api.

Dependencies

This service depends upon:

Find Us

Versioning

For the versions available, see the tags on this repository.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENCE.md file for details.