Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/civil-orchestrator-service
Backend Java service to manage external apis to civil
https://github.com/hmcts/civil-orchestrator-service
jenkins-cft jenkins-cft-a-c
Last synced: about 1 month ago
JSON representation
Backend Java service to manage external apis to civil
- Host: GitHub
- URL: https://github.com/hmcts/civil-orchestrator-service
- Owner: hmcts
- License: mit
- Created: 2023-05-31T14:59:41.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-21T22:15:58.000Z (8 months ago)
- Last Synced: 2024-04-22T00:54:57.951Z (8 months ago)
- Topics: jenkins-cft, jenkins-cft-a-c
- Language: Java
- Homepage:
- Size: 3.73 MB
- Stars: 1
- Watchers: 26
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://gradle.org) 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:
```bash
./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](https://www.docmosis.com/) is our document generation service. For development purposes we have been using trial keys which can be obtained [here](https://www.docmosis.com/products/tornado/try.html). **Note:** These expire after a month. | |
| `GOV_NOTIFY_API_KEY` | [GOV.UK Notify](https://www.notifications.service.gov.uk/) is our notification service for sending emails. | |
| `LAUNCH_DARKLY_SDK_KEY` | [LaunchDarkly](https://launchdarkly.com/) 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:
```bash
./gradlew assemble
```
Create docker image:
```bash
docker-compose build
```
Run the distribution (created in `build/install/civil-orchestrator-service` directory)
by executing the following command:
```bash
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:
```bash
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](LICENSE) file for details