Evidence Management Annotation App

Annotation API is a backend service to store and retrieve annotations.

Quickstart.

To clone repo and prepare to pull containers:

git clone https://github.com/hmcts/em-annotation-app.git
cd em-annotation-app/
brew install jq

Clean and build the application:

Requires docker desktop running

./gradlew clean
./gradlew build

To run the application:

At the moment java version must be set to 17 as 21 is not supported for local setup by CFTLib

./gradlew bootWithCCD

To remove docker containers after stopping the run:

docker stop $(docker ps -a -q)
docker rm $(docker ps -a -f status=exited -q)

Potential issues and solutions

Port 5000 is already in use on Monterey macs:

Disable AirPlay receiver

Authentication issues causing containers to not start:

docker logout hmctspublic.azurecr.io

Swagger UI

To view our REST API go to http://{HOST}/swagger-ui/index.html On local machine with server up and running, link to swagger is as below

http://localhost:8080/swagger-ui/index.html if running on AAT, replace localhost with ingressHost data inside values.yaml class in the necessary component, making sure port number is also removed.

API Endpoints

A list of our endpoints can be found here

https://hmcts.github.io/reform-api-docs/specs/rpa-em-annotation-app.json

Running contract or pact tests:

You can run contract or pact tests as follows:

./gradlew clean

./gradlew contract

You can then publish your pact tests locally by first running the pact docker-compose:

docker-compose -f docker-pactbroker-compose.yml up

and then using it to publish your tests:

./gradlew pactPublish

Tech

It uses:

• Java11
• Spring boot
• Junit, Mockito and SpringBootTest and Powermockito
• Gradle
• lombok project - Lombok project

Plugins

• lombok plugin - Lombok IDEA plugin

License

This project is licensed under the MIT License - see the LICENSE file for details