civil-orchestrator-service

Building and deploying the application

Building the application

Civil orchestration service for bulk claims

Building and deploying the application

Dependencies

The project is dependent on other Civil repositories:

civil-ccd-definition civil-service

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

Environment variables You will need the following environment variables setup in your bashrc/zshrc or IntelliJ run configuration. API keys can be found in the Azure key store.

Name	Use	Value
DOCMOSIS_TORNADO_KEY	Docmosis is our document generation service. For development purposes we have been using trial keys which can be obtained here. Note: These expire after a month.
GOV_NOTIFY_API_KEY	GOV.UK Notify is our notification service for sending emails.
LAUNCH_DARKLY_SDK_KEY	LaunchDarkly is our platform for managing feature toggles.
LAUNCH_DARKLY_OFFLINE_MODE	Sets LaunchDarkly to use local values for flags rather than connecting to the service	true
SPRING_PROFILES_ACTIVE	Sets the active Spring profile	local

Running through IntelliJ

IntelliJ will create a Spring Boot run configuration for you. Which, after setting up your environment variables, can be run from there.

###Create a Docker image While not necessary for local development, you can 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/civil-orchestrator-service directory) by executing the following command:

  docker-compose up

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

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

  curl http://localhost:9090/health

You should get a response similar to this:

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

License

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