hmpps-jobs-board-api

About

The Match Jobs and Manage Applications - Jobs Board API provides backend services Jobs Uploads, Employers Uploads and Candidate Matching.

• The product page on Developer Portal: Match Jobs and Manage Applications
• The high level design on Confluence: Match Jobs & Manage Applications - HLD

Team

This backend service is developed and supported by Education Skills & Work team. They can be contacted via #education-skills-work-employment-dev on Slack.

Healthiness

The integration service has a /health endpoint which indicates the service is up and running.

Instructions

Running the application locally

This backend application depends on several services to run.

Dependency	Description	Default	Override Env Var
hmpps-auth	OAuth2 API server for authenticating requests		API_BASE_URL_OAUTH
OS Places API	OS Places API for resolving postcodes	https://api.os.uk/search/places/v1	OS_PLACES_API_URL
Database	Database server (postgres on local, RDS on live env)		DATABASE_NAME, DATABASE_ENDPOINT, DATABASE_USERNAME and DATABASE_PASSWORD

|

Environment variables

Defining env var for local run

Env. var.	description
DATABASE_ENDPOINT	Database Endpoint (address with port)
DATABASE_NAME	Database Name
DATABASE_USERNAME	Database user's username
DATABASE_PASSWORD	Database user's password
OS_PLACES_API_KEY	API access key for OS Places API (per given environment)
* These values can be obtained from k8s secrets on dev env.

• Run with the Spring profile dev on local
  • Set active profile via this environmental variable spring.profiles.active=dev or SPRING_PROFILES_ACTIVE=dev
• Run with the Spring profile local group on local
  • Set active profile to local: spring.profiles.active=local or SPRING_PROFILES_ACTIVE=local
  • The local group will utilise localstack for Integration features with message queue (SQS)
• API Spec:
  • Goto http://localhost:8080/swagger-ui/index.html to explore the OpenAPI specifications
• Checking endpoints
  • Goto http://localhost:8080/health to check the service is up and running

Running with Docker

• Define/Override env var.: define a .env file with () required env var from above; Syntax of .env file

  • provide API key only

    OS_PLACES_API_KEY=<API-ACCESS-KEY>
    

  • Specify API key and override Auth URL

    OS_PLACES_API_KEY=<API-ACCESS-KEY>
    API_BASE_URL_OAUTH=https://sign-in-dev.hmpps.service.justice.gov.uk/auth
    

• Run this at CLI

  docker compose pull && docker compose up -d

will build the application and run it with a PostgreSQL database and localstack within local docker.

Running the application in Intellij

• Run this at CLI

  docker compose pull && docker compose up --scale hmpps-jobs-board-api=0 -d

• will just start docker instance of PostgreSQL database and localstack. The application should then be started with a dev or local active profile in Intellij.
  • supply required env var, e.g.
    • spring.profiles.active=dev;os.places.api.key=<API-ACCESS-KEY>
    • spring.profiles.active=local;os.places.api.key=<API-ACCESS-KEY>