https://github.com/hmcts/labs-stuartbjustice

https://github.com/hmcts/labs-stuartbjustice

jenkins-cft-j-z labs

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/hmcts/labs-stuartbjustice
• Owner: hmcts
• License: mit
• Created: 2023-01-13T15:44:57.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-12T05:29:50.000Z (about 1 month ago)
• Last Synced: 2024-11-12T06:24:43.281Z (about 1 month ago)
• Topics: jenkins-cft-j-z, labs
• Language: Java
• Size: 132 KB
• Stars: 0
• Watchers: 72
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# labs-StuartBJustice

The application exposes health endpoints (http://localhost:8080/health) and metrics endpoint

(http://localhost:8080/metrics).

## Notes

JUnit 5 is enabled by default in the project. Please refrain from using JUnit4 and use the next generation

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

```

### 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/spring-boot-template` 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.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details