Skip to main content

Getting started

Prerequisites

  • Java 25 or higher
  • Gradle 9.3.0 or higher (optional, as gradle-wrapper is used)
  • Docker (optional, for containerized development)
  • Git 2.9 or later

Clone the repository

git clone https://github.com/ministryofjustice/laa-data-provider-data.git
cd laa-data-provider-data

Build from source

./gradlew clean build

Running the application locally

Using Gradle

./gradlew bootRun

Using Docker

docker compose up

Accessing the API

Once running, browse to: - Swagger UI: http://localhost:8080 - Health Check: http://localhost:8080/actuator/health

Configuration

For local development, some default configuration is overridden in application-local.yml.

API key

When using Swagger or tools such as Postman, an API token is required.

A dummy API key for local development is available in the application-local.yml file.

Next steps