https://github.com/hmcts/bar-api
https://github.com/hmcts/bar-api
jenkins-cft jenkins-cft-a-c
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hmcts/bar-api
- Owner: hmcts
- Created: 2017-12-08T09:20:13.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-11T04:07:37.000Z (9 months ago)
- Last Synced: 2025-04-11T05:20:04.116Z (9 months ago)
- Topics: jenkins-cft, jenkins-cft-a-c
- Language: Java
- Size: 4.32 MB
- Stars: 2
- Watchers: 13
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Audit: audit.json
Awesome Lists containing this project
README
# Bank Accounting Returns for HMCTS online services
[](https://app.codacy.com/app/jaleen/bar-apps?utm_source=github.com&utm_medium=referral&utm_content=hmcts/bar-apps&utm_campaign=badger)
[](https://travis-ci.org/hmcts/bar-app)
[](https://codecov.io/gh/hmcts/bar-app)
This project provides REST based web services for exposing BAR related information for hearing fee and award fees.
### Getting Started
This is SpringBoot+maven based java application. Please see the Jenkinsfile in root folder to see the build and deployment pipeline.
### Prerequisites
You will need jdk and maven installed on your machine or use mvnw to install the prerequisites.
### Installing
1. Clone the repo to your machine using git clone git@git.reform.hmcts.net:bar/bar-app.git
2. Run $ ./gradlew build
## Running the tests
You can run the tests using 'gradle test or ./gradlew test'
## Deployment
See Jenkinsfile for the deployment details
## Run the application
To run the application at local developer machine use following command
$ gradle bootRun or ./gradlew bootRun
Once application server is started use swagger ui to find the endpoints and test these.
http://localhost:8080/swagger-ui.html
or in dev/test environment you can use this link
https://dev.api.bar.reform.hmcts.net/swagger-ui.html
or https://test.api.bar.reform.hmcts.net/swagger-ui.html
## Service Endpoints
Some of the end points are as below. These might be out of date. Please look at the swagger-ui to be sure.
- GET /bar/hello
## Built With
* [Gradle](https://gradle.org/) - Dependency Management
## Service Versioning
We use [SemVer](http://semver.org/) for versioning.