A# End Tenancy

This project is built with HOF-Bootstrap and uses Docker.

Getting started

Get the project from Github.

$ git clone [email protected]:UKHomeOffice/end-tenancy.git && cd end-tenancy

Install the dependencies and build the project resources

$ yarn install

You'll also need a pdf-generator to the run the app fully end to end. The recommended one is https://github.com/UKHomeOffice/html-pdf-converter.

You'll need to set the port number accordingly with the pdf generator. In docker you set the port number, docker run -p 8080:8001 [image-name]

You'll then need to set an environment variable for the end-tenancy app

PDF_CONVERTER_URL=http://localhost:8001/convert

Install Docker Compose

Run the services locally with Docker Compose

$ docker-compose up

Run the services locally outside of Docker Compose (You'll need Redis for this)

$ yarn run dev

For anything else end-tenancy-related, look in package.json for a full list of scripts etc, and config.js for environment variables.

Otherwise, see HOF-Bootstrap.