nfdiv-case-definition v0.0.1

No Fault Divorce Case API

This API handles callbacks from CCD for the NO_FAULT_DIVORCE case type.

Building and deploying the application

Building the application

The project uses Gradle as a build tool. It already contains ./gradlew wrapper script, so there's no need to install gradle.

To build the project execute the following command:

  ./gradlew build

Running the application

Create the image of the application by executing the following command:

  ./gradlew assemble

Create docker image:

  docker-compose build

Run the distribution (created in build/install/nfdiv-caseapi directory) by executing the following command:

  docker-compose up

This will start the API container exposing the application's port (set to 4013 in this template app).

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:4013/health

You should get a response similar to this:

  {"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}

Alternative script to run application

To skip all the setting up and building, just execute the following command:

./bin/run-in-docker.sh

For more information:

./bin/run-in-docker.sh -h

Script includes bare minimum environment variables necessary to start api instance. Whenever any variable is changed or any other script regarding docker image/container build, the suggested way to ensure all is cleaned up properly is by this command:

docker-compose rm

It clears stopped containers correctly. Might consider removing clutter of images too, especially the ones fiddled with:

docker images

docker image rm <image-id>

There is no need to remove postgres and java or similar core images.

Generate CCD JSON files

To generate the CCD JSON files from the Java Model run the following from the root of the project:

./gradlew ccd-definitions:generateCCDConfig

Generate TypeScript definitions for CCD definition

./gradlew generateTypeScript

Note that any master build will automatically bump the @hmcts/nfdiv-case-defintions package and publish it.

License

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