Interventions Catalogue UI
Getting started
The easiest way to run the app is to use docker compose to build the local app as a docker image and download and run the three required containers.
docker-compose pull
docker-compose up
Dependencies
The app requires:
Nomis Oauth2 Server
for authenticationInterventions Catalogue Service
for interventions catalogue data
Runing the app for development**
To start the main services excluding the interventions catalogue ui app:
docker-compose up --scale=interventions-catalogue-ui=0
Install dependencies using npm install
, ensuring you are using >= Node v10.15.3
And then, to build the assets and start the app with nodemon:
npm run start:dev
Accessing the application
Env variables
In config.js you can see all the required variables. These are set with defaults that will allow the application to run, but you will need to add a .env
file at some point.
Run linter
npm run lint
Run tests
npm run test
Running integration tests
For local running, start a test db, redis, and wiremock instance by:
docker-compose -f docker-compose.test.yml up
Then run the server in test mode by:
npm run start-feature
(or npm run start-feature:dev
to run with nodemon)
And then either, run tests in headless mode with:
npm run int-test
Or run tests with the cypress UI:
npm run int-test-ui