Document Generator

This is a document generation and template management service. This allows to generate documents based on a given template name and placeholder data in JSON format and will also store the generated document in the Evidence Management Store.

The service provides a single RESTful endpoint that will generate the document, store it in Evidence Management Store and return the link to the stored data.

Getting started

Prerequisites

• JDK 8
• Docker

Flow Diagram

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

Running

First you need to create distribution by executing following command:

    ./gradlew installDist

When the distribution has been created in build/install/div-document-generator directory, you can run the application by executing following command:

1. Run

docker build . -t hmcts/finrem-document-generator-client:latest

2. Export docmosis-api-access-key (ask finrem dev members to provide one)

export PDF_SERVICE_ACCESS_KEY=<ACTUAL_KEY>

3. Run

    docker-compose up

As a result the following container(s) will get created and started:

• long living container for API application exposing port 4009

API documentation

API documentation is provided with Swagger:

• http://localhost:4009/swagger-ui.html - UI to interact with the API resources

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

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Standard API

We follow RESTful API standards.

License

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