https://github.com/hmcts/civil-general-applications
Backend Java service to manage General Applications
https://github.com/hmcts/civil-general-applications
jenkins-cft jenkins-cft-a-c
Last synced: about 1 month ago
JSON representation
Backend Java service to manage General Applications
- Host: GitHub
- URL: https://github.com/hmcts/civil-general-applications
- Owner: hmcts
- License: mit
- Created: 2021-11-17T10:28:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-04-17T11:47:48.000Z (about 2 months ago)
- Last Synced: 2025-04-17T23:44:27.144Z (about 2 months ago)
- Topics: jenkins-cft, jenkins-cft-a-c
- Language: Java
- Size: 6.62 MB
- Stars: 3
- Watchers: 34
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# civil-general-applications
[](https://travis-ci.org/hmcts/civil-general-applications)
## Notes
JUnit 5 is now enabled by default in the project. Please refrain from using JUnit4 and use the next generation
After updated to OpenApi 3.0, the swagger interface now is at http://localhost:4550/swagger-ui/index.html
## Building and deploying the application
### 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
```
for running depdendency check locally
./gradlew --no-daemon --stacktrace -DdependencyCheck.failBuild=true -Dnvd.api.check.validforhours=24 -Danalyzer.central.enabled=false -Danalyzer.retirejs.enabled=false -Danalyzer.ossindex.enabled=false -Dnvd.api.key= dependencyCheckAggregate
### Running the application
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-general-applications` directory)
by executing the following command:
```bash
docker-compose up
```
This will start the API container exposing the application's port
(set to `4550` in this template app).
In order to test if the application is up, you can call its health endpoint:
```bash
curl http://localhost:4550/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:
```bash
./bin/run-in-docker.sh
```
For more information:
```bash
./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:
```bash
docker-compose rm
```
It clears stopped containers correctly. Might consider removing clutter of images too, especially the ones fiddled with:
```bash
docker images
docker image rm
```
There is no need to remove postgres and java or similar core images.
### Other
Hystrix offers much more than Circuit Breaker pattern implementation or command monitoring.
Here are some other functionalities it provides:
* [Separate, per-dependency thread pools](https://github.com/Netflix/Hystrix/wiki/How-it-Works#isolation)
* [Semaphores](https://github.com/Netflix/Hystrix/wiki/How-it-Works#semaphores), which you can use to limit
the number of concurrent calls to any given dependency
* [Request caching](https://github.com/Netflix/Hystrix/wiki/How-it-Works#request-caching), allowing
different code paths to execute Hystrix Commands without worrying about duplicating work
## Adding Git Conventions
### Include the git conventions.
* Make sure your git version is at least 2.9 using the `git --version` command
* Run the following command:
```
git config --local core.hooksPath .git-config/hooks
```
Once the above is done, you will be required to follow specific conventions for your commit messages and branch names.
If you violate a convention, the git error message will report clearly the convention you should follow and provide
additional information where necessary.
*Optional:*
* Install this plugin in Chrome: https://github.com/refined-github/refined-github
It will automatically set the title for new PRs according to the first commit message, so you won't have to change it manually.
Note that it will also alter other behaviours in GitHub. Hopefully these will also be improvements to you.
*In case of problems*
1. Get in touch with your Technical Lead so that they can get you unblocked
2. If the rare eventuality that the above is not possible, you can disable enforcement of conventions using the following command
`git config --local --unset core.hooksPath`
Still, you shouldn't be doing it so make sure you get in touch with a Technical Lead soon afterwards.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details