https://github.com/hmcts/ccpay-refunds-app

This repository belongs to Fees&Pay Team and it is created to maintain refunds related code.
https://github.com/hmcts/ccpay-refunds-app

jenkins-cft jenkins-cft-a-c

Last synced: about 1 month ago
JSON representation

This repository belongs to Fees&Pay Team and it is created to maintain refunds related code.

• Host: GitHub
• URL: https://github.com/hmcts/ccpay-refunds-app
• Owner: hmcts
• License: mit
• Created: 2021-06-07T13:33:43.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-17T18:27:10.000Z (7 months ago)
• Last Synced: 2024-05-18T07:24:57.270Z (7 months ago)
• Topics: jenkins-cft, jenkins-cft-a-c
• Language: Java
• Size: 10.3 MB
• Stars: 0
• Watchers: 20
• Forks: 1
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Audit: audit.json

Awesome Lists containing this project

README

        
# ccpay-refunds-app template

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

 

## 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/refunds-app` directory)

by executing the following command:

```bash

  docker-compose up

```

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

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

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

```bash

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