Skip to content

README.md

Latest commit

 

History

History
109 lines (73 loc) · 4.46 KB

README.md

File metadata and controls

109 lines (73 loc) · 4.46 KB

Special Tribunals Case API License: MIT

This API handles callbacks from CCD for the Criminal Injuries Compensation (CIC) (and other services, in the future e.g. Mental Health) case type for Special Tribunals (ST).

Overview

                    ┌──────────────────┐
                    │                  │
                    │ SPTRIBS-CASE-API │
                    │                  │
                    └───────▲──────────┘
                            │
                            │
                    ┌───────▼────────┐
                    │                │
              ┌─────►      CCD       ◄─────┐
              │     │                │     │
              │     └────────────────┘     │
              │                            │
      ┌───────┴───────────┐        ┌───────┴───────┐
      │                   │        │               │
      │ SPTRIBS-FRONTEND  │        │       XUI     │
      │                   │        │               │
      └───────────────────┘        └───────────────┘

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 locally

You will need access to the sptribs-aat vault, and an active VPN to run locally, as it depends on services running on AAT.

This will require an Azure login, which can be done with the Azure CLI with: az login and following the steps to log into Azure az acr login --name hmctsprod to access the ACR namespace as part of bootWithCCD or generateCCDConfig/buildCCDXlsx

Run the application by executing the following command:

./gradlew bootRun

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}}

Running the application locally with CCD and XUI

If you would like to run the full CCD and XUI stack locally you can use:

./gradlew bootWithCcd

This will start a containers for the CFTLib components (ccd-elasticsearch,xui-manage-org, xui-manage-cases, postgres database) Then you can access XUI on http://localhost:3000

Generate CCD JSON files

Generating the CCD JSON files will happen on every ./gradlew bootWithCcd but you can manually trigger this with:

./gradlew generateCCDConfig

Generate TypeScript definitions for CCD definition

./gradlew generateTypeScript

Using a Local version of the CCD-Config-Generator

You can edit the ccd-config generator and test a local version by checking out the project, making changes and running the publishToMavenLocal gradle task Then uncomment the dependency in build.gradle like so:

  implementation group: 'com.github.hmcts', name: 'ccd-config-generator', version: 'DEV-SNAPSHOT'

GitHub Labels

On a pull request you can add the following labels:

  • enable_keep_helm - to keep the deployment in the preview environment for testing after the pipeline has finished
  • pr-values:wa - use the values.wa.preview.template.yaml to deploy with Work Allocation pods
  • pr-values:wa-ft-tests - run the Work Allocation Functional tests (requires the above)
  • enable_ccd_diff - runs the ccd-diff workflow to show changes to the CCD definition

Crons

You can manually run a cron task from the cli:

TASK_NAME=[task] java -jar sptribs-case-api.jar run

# E.g.
TASK_NAME=SystemProgressHeldCasesTask java -jar sptribs-case-api.jar

# or
TASK_NAME=SystemProgressHeldCasesTask ./gradlew bootRun

License

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