API for the Strengths and Needs assessment service.
The service and all of its dependencies are run in Docker containers.
To start it, run:
make up
The service is on http://localhost:8080
To check the status, go to http://localhost:8080/health
The UI can be accessed on http://localhost:7072
The Swagger docs are on http://localhost:8080/swagger-ui/index.html
To update containers
make down update up
To start the API in development mode, run:
make dev-up
To enable live-reload after starting in development mode, run:
make watch
A remote debugger can be attached to the containerised JVM on port 5005
To generate an authentication token (JWT) for the local API, run:
make dev-api-token
Run make to see the full list of dev commands.
make lint to run the linter.
make test to run the test suite.
Deployments of the main branch to Development -> Preproduction -> Production are automated through the build-test-and-deploy workflow in CircleCI.
To deploy a branch manually to the Test environment, open the project in CircleCI and follow these steps:
- Select the branch you wish to deploy
- Press the "Trigger Pipeline" button
- Add a string parameter named "deploy" with value "test"
- Press "Trigger Pipeline"
- hmpps-auth - for authentication using OAuth/JWT
- PostgreSQL - for persisting assessment data