{"id":20726870,"url":"https://github.com/hmcts/rpe-pdf-service","last_synced_at":"2025-04-23T18:49:04.911Z","repository":{"id":37821224,"uuid":"101856143","full_name":"hmcts/rpe-pdf-service","owner":"hmcts","description":"Allows to generate PDFs based on given template and placeholder data","archived":false,"fork":false,"pushed_at":"2025-04-17T20:27:19.000Z","size":22102,"stargazers_count":6,"open_issues_count":13,"forks_count":1,"subscribers_count":44,"default_branch":"master","last_synced_at":"2025-04-18T10:48:15.816Z","etag":null,"topics":["civil-money-claims","govuk","gradle","html-to-pdf","java","jenkins-cft","jenkins-cft-j-z","jenkins-pipeline","pdf","platops-owned-app","spring","spring-boot","spring-mvc","team-platform"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hmcts.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-30T08:18:02.000Z","updated_at":"2025-03-27T09:08:45.000Z","dependencies_parsed_at":"2024-02-09T04:25:36.991Z","dependency_job_id":"f1cddbac-7971-4c22-84e8-9f20e5c92dbe","html_url":"https://github.com/hmcts/rpe-pdf-service","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmcts%2Frpe-pdf-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmcts%2Frpe-pdf-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmcts%2Frpe-pdf-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmcts%2Frpe-pdf-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hmcts","download_url":"https://codeload.github.com/hmcts/rpe-pdf-service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250495899,"owners_count":21440225,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["civil-money-claims","govuk","gradle","html-to-pdf","java","jenkins-cft","jenkins-cft-j-z","jenkins-pipeline","pdf","platops-owned-app","spring","spring-boot","spring-mvc","team-platform"],"created_at":"2024-11-17T04:27:57.100Z","updated_at":"2025-04-23T18:49:04.892Z","avatar_url":"https://github.com/hmcts.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PDF service\n\n[![codecov](https://codecov.io/gh/hmcts/rpe-pdf-service/branch/master/graph/badge.svg)](https://codecov.io/gh/hmcts/rpe-pdf-service)\n\nThis is a PDF service which allows to generate read-only PDFs based on given template in HTML/Twig format and\nplaceholder data in JSON format.\nThe service provides a single RESTful endpoint that merges both template and placeholder data together and\nreturns the PDF as a binary stream.\n\nThe template, besides containing ordinary HTML markup, can also contain inline CSS styling and embedded images.\n\n## Getting started\n\n### Prerequisites\n\n- [Java 17](https://www.oracle.com/java)\n- [Docker](https://www.docker.com)\n\n![diagram](docs/component-diagram.jpg)\n\n### Building\n\nThe project uses [Gradle](https://gradle.org) as a build tool but you don't have to install it locally since there is a\n`./gradlew` wrapper script.\n\nTo build project please execute the following command:\n\n```bash\n    ./gradlew build\n```\n\n### Running\n\nFirst you need to create distribution by executing following command:\n\n```bash\n    ./gradlew installDist\n```\n\nWhen the distribution has been created in `build/install/pdf-service` directory,\nyou can run the application by executing following command:\n\n```bash\n    docker-compose up\n```\n\nAs a result the following container(s) will get created and started:\n - long living container for API application exposing port `5500`\n\n### API documentation\n\nAPI documentation is provided with Swagger:\n - `http://localhost:5500/swagger-ui.html` - UI to interact with the API resources\n\nNOTE: Swagger scans classes in the `uk.gov.hmcts.reform.pdfservice.controllers` package.\n\n### Consuming\nThere is a client library provided for java https://github.com/hmcts/cmc-pdf-service-client\n\n### Docker\nImage is available in the HMCTS azure container registry (currently private) @ `hmcts.azurecr.io/hmcts/rpe/pdf-service`. See usage example in: [docker-compose.yml](docker-compose.yml)\n\n#### Non ASCII Characters Support\n\nTo render PDF with non ASCII characters, please use the 'Open Sans' font-family.\n\n```css\nfont-family: 'Open Sans';\n```\n\nExample:\n\n```html\n\u003chead\u003e\n   \u003cstyle\u003e\n      html {\n      font-family: 'Open Sans';\n      }\n   \u003c/style\u003e\n\u003c/head\u003e\n\n```\n\n## Developing\n\n### Unit tests\n\nTo run all unit tests please execute following command:\n\n```bash\n    ./gradlew test\n```\n\n### Coding style tests\n\nTo run all checks (including unit tests) please execute following command:\n\n```bash\n    ./gradlew check\n```\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning.\nFor the versions available, see the tags on this repository.\n\n## Standard API\n\nWe follow [RESTful API standards](https://hmcts.github.io/restful-api-standards/).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmcts%2Frpe-pdf-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhmcts%2Frpe-pdf-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmcts%2Frpe-pdf-service/lists"}