https://github.com/hmcts/civil-sdt-commissioning

SDT Commissioning Service
https://github.com/hmcts/civil-sdt-commissioning

jenkins-cft-a-c

Last synced: about 1 month ago
JSON representation

SDT Commissioning Service

• Host: GitHub
• URL: https://github.com/hmcts/civil-sdt-commissioning
• Owner: hmcts
• License: mit
• Created: 2023-03-08T11:03:05.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-11T09:26:49.000Z (about 1 month ago)
• Last Synced: 2024-11-11T10:29:13.416Z (about 1 month ago)
• Topics: jenkins-cft-a-c
• Language: Java
• Homepage:
• Size: 5.43 MB
• Stars: 1
• Watchers: 63
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Civil SDT Commissioning

[![Build Status](https://travis-ci.org/hmcts/sdt-commissioning.svg?branch=master)](https://travis-ci.org/hmcts/sdt-commissioning)

## Notes

Since Spring Boot 2.1 bean overriding is disabled. If you want to enable it you will need to set `spring.main.allow-bean-definition-overriding` to `true`.

JUnit 5 is now 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/civil-sdt-commissioning` directory)

by executing the following command:

```bash

  docker-compose up

```

This will start the API container exposing the application's port

(set to `4750` in this template app).

In order to test if the application is up, you can call its health endpoint:

```bash

  curl http://localhost:4750/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