Ethos Replacement Doc Generation Service

This application generates documents from templates using Docmosis -> Tornado.

Getting started

Prerequisites

• JDK 11

Building

The project uses Gradle as a build tool but you don't have to install it locally since there is a ./gradlew wrapper script.

To build project please execute the following command:

    ./gradlew build

To get the project to build in IntelliJ IDEA, you have to:

• Install the Lombok plugin: Preferences -> Plugins
• Enable Annotation Processing: Preferences -> Build, Execution, Deployment -> Compiler -> Annotation Processors

Running

You can run the application by executing following command:

    ./gradlew bootRun

The application will start locally on http://localhost:8081

API documentation

API documentation is provided with Swagger: UI to interact with the API resources

    http://localhost:8081/swagger-ui.html

Docker container

Authenticating to ACR

Login to Azure CLI

    az login

Login to ACR

    az acr login --name hmctspublic

Docker image

Build the docker image

    docker build . -t hmcts/ethos-repl-docmosis-service:latest

Docker compose

Run the service with all its dependencies

    docker-compose -f docker/app.yml up -d

To stop the service

    docker-compose -f docker/app.yml down

Developing

Unit tests

To run all unit tests please execute following command:

    ./gradlew test

Coding style tests

To run all checks (including unit tests) please execute following command:

    ./gradlew check

License

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