Store/search cases and provide workbaskets
The following environment variables are required:
| Name | Default | Description |
|---|---|---|
| DATA_STORE_DB_HOST | localhost | Host for database |
| DATA_STORE_DB_PORT | 5432 | Port for database |
| DATA_STORE_DB_USERNAME | - | Username for database |
| DATA_STORE_DB_PASSWORD | - | Password for database |
| DATA_STORE_TOKEN_SECRET | <random string> |
Secret for generating internal JWT tokens for events |
| DATA_STORE_IDAM_KEY | - | Definition store's IDAM S2S micro-service secret key. This must match the IDAM instance it's being run against. |
| DATA_STORE_S2S_AUTHORISED_SERVICES | ccd_gw | Authorised micro-service names for S2S calls |
| IDAM_USER_URL | - | Base URL for IdAM's User API service (idam-app). http://localhost:4501 for the dockerised local instance or tunneled dev instance. |
| IDAM_S2S_URL | - | Base URL for IdAM's S2S API service (service-auth-provider). http://localhost:4502 for the dockerised local instance or tunneled dev instance. |
| USER_PROFILE_HOST | - | Base URL for the User Profile service. http://localhost:4453 for the dockerised local instance. |
| DEFINITION_STORE_HOST | - | Base URL for the Definition Store service. http://localhost:4451 for the dockerised local instance. |
| CCD_DM_DOMAIN | - | Base URL for the Document Management domain. |
| APPINSIGHTS_INSTRUMENTATIONKEY | - | For CNP environment this is provided by the terraform scripts. However any value would do for your local environment. |
| DATA_STORE_DB_USE_SSL | true | Mandated by Cloud Native Platform. For local testing, set this variable to false |
| DATA_STORE_DEFAULT_LOG_LEVEL | INFO | Default log level for classes under package uk.gov.hmcts.ccd |
The project uses Gradle.
To build project please execute the following command:
./gradlew clean buildIf you want your code to become available to other Docker projects (e.g. for local environment testing), you need to build the image:
docker-compose buildThe above will build both the application and database images.
If you want to build only one of them just specify the name assigned in docker compose file, e.g.:
docker-compose build ccd-data-store-apiWhen the project has been packaged in target/ directory,
you can run it by executing following command:
docker-compose upAs a result the following containers will get created and started:
- Database exposing port
5452 - API exposing ports
4452
Database will get initiated when you run docker-compose up for the first time by execute all scripts from database directory.
You don't need to migrate database manually since migrations are executed every time docker-compose up is executed.
You can connect to the database at http://localhost:5452 with the username and password set in the environment variables.
This project is licensed under the MIT License - see the LICENSE file for details.