https://github.com/hmcts/cmc-pdf-service-client
Java client library for https://github.com/hmcts/cmc-pdf-service
https://github.com/hmcts/cmc-pdf-service-client
civil-money-claims govuk gradle java spring travis-ci
Last synced: about 1 year ago
JSON representation
Java client library for https://github.com/hmcts/cmc-pdf-service
- Host: GitHub
- URL: https://github.com/hmcts/cmc-pdf-service-client
- Owner: hmcts
- License: mit
- Created: 2017-09-06T13:15:35.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-04-11T14:49:44.000Z (about 1 year ago)
- Last Synced: 2025-04-11T15:53:30.713Z (about 1 year ago)
- Topics: civil-money-claims, govuk, gradle, java, spring, travis-ci
- Language: Java
- Homepage:
- Size: 255 KB
- Stars: 1
- Watchers: 189
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://jitpack.io/#hmcts/cmc-pdf-service-client)
[](https://github.com/hmcts/cmc-pdf-service-client/actions/workflows/gradle.yml)
# PDF service client
This is a client library for pdf-service, which allows to generate read-only PDFs based on given template in HTML/Twig format and
placeholder data in JSON format.
## Getting started
### Prerequisites
- [JDK 17](https://www.oracle.com/java)
### Building
The project uses [Gradle](https://gradle.org) as a build tool but you don't have to install it locally since there is a
`./gradlew` wrapper script.
To build project please execute the following command:
```bash
./gradlew build
```
## Developing
### Unit tests
To run all unit tests please execute following command:
```bash
./gradlew test
```
### Coding style tests
To run all checks (including unit tests) please execute following command:
```bash
./gradlew check
```
## Versioning
We use [SemVer](http://semver.org/) for versioning.
For the versions available, see the tags on this repository.
To release a new version add a tag with the version number and push this up to the origin repository. This will then
build and publish the release to maven.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.