{"id":13705249,"url":"https://github.com/shipsaas/docking","last_synced_at":"2025-04-07T08:17:50.250Z","repository":{"id":154167301,"uuid":"629451252","full_name":"shipsaas/docking","owner":"shipsaas","description":"DocKing: Your shared-microservice that takes over the document templates management \u0026 render/export PDF","archived":false,"fork":false,"pushed_at":"2024-05-23T03:52:48.000Z","size":2206,"stargazers_count":253,"open_issues_count":4,"forks_count":17,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-31T07:05:32.328Z","etag":null,"topics":["document","document-templates","laravel","microservice","pdf","pdf-generation","pdf-render","pdf-renderer","php"],"latest_commit_sha":null,"homepage":"https://docking.shipsaas.tech","language":"PHP","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/shipsaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-18T10:43:13.000Z","updated_at":"2025-03-24T23:32:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"8785cdf9-9321-409f-9aad-5ebfb23d0711","html_url":"https://github.com/shipsaas/docking","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipsaas%2Fdocking","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipsaas%2Fdocking/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipsaas%2Fdocking/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shipsaas%2Fdocking/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shipsaas","download_url":"https://codeload.github.com/shipsaas/docking/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247615385,"owners_count":20967184,"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":["document","document-templates","laravel","microservice","pdf","pdf-generation","pdf-render","pdf-renderer","php"],"created_at":"2024-08-02T22:00:35.937Z","updated_at":"2025-04-07T08:17:50.232Z","avatar_url":"https://github.com/shipsaas.png","language":"PHP","readme":"# DocKing from ShipSaaS\n\n## Introducing RenderPDF.io - Render your PDF in seconds\n\n![RenderPDF.io](./.github/render-pdf-io.png)\n\n[RenderPDF.io](https://renderpdf.io) is a Render-PDF-as-a-Service that provides developer-friendly APIs \nto render your HTML content to modern PDFs files in seconds 😎.\n\nAll you have to do is get your API Key and send RenderPDF.io an API call 🚀, no infrastructure setup, no overhead and\nhassle-free integration 🔋.\n\nGet your free API Key today: [Sign Up to RenderPDF.io](https://renderpdf.io)\n\n## Introducing DocKing\n\n[![Build \u0026 Test (PHP 8.2)](https://github.com/shipsaas/docking/actions/workflows/build.yml/badge.svg)](https://github.com/shipsaas/docking/actions/workflows/build.yml)\n[![Integration Tests](https://github.com/shipsaas/docking/actions/workflows/integration.yml/badge.svg)](https://github.com/shipsaas/docking/actions/workflows/integration.yml)\n[![E2E Tests](https://github.com/shipsaas/docking/actions/workflows/e2e.yml/badge.svg)](https://github.com/shipsaas/docking/actions/workflows/e2e.yml)\n[![codecov](https://codecov.io/gh/shipsaas/docking/branch/main/graph/badge.svg?token=FAZ9899IPW)](https://codecov.io/gh/shipsaas/docking)\n\n\u003cp align=\"center\" width=\"100%\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/shipsaas/docking/main/docs/img/logo.png\"\u003e \n\u003c/p\u003e\n\nDocKing is a document management service/microservice that handles templates and renders them in PDF format, all in one place.\n\nYou can utilize DocKing as a shared microservice, which can be integrated \u0026 used in any service from your big product.\n\nDocumentation: [DocKing](https://docking.shipsaas.tech)\n\nDocKing is well-tested \u0026 production-ready 😉🏎️🚀\n\n## LIVE DEMO 🔥\n\nURL: https://docking-demo.shipsaas.tech/\n\nConsole: https://docking-demo.shipsaas.tech/console#/\n\n\n- Password: None\n- Drivers:\n  - Gotenberg: Yes, use the Live Demo Instance (from Gotenberg.dev)\n  - WkHtmlToPdf: Yes, without any extensions or fonts.\n  - mPDF: Yes, without any extensions or fonts.\n- Most of the features are disabled. You can only view \u0026 preview PDFs in multiple drivers.\n\n## Features 🚀\n- Manage all of your document templates just in one place 📰🧾.\n- Dynamically render \u0026 export PDF from your desired data 🏃‍.\n- Supports multiple state-of-the-art PDF Engines 🍻.\n- Supports sync \u0026 async PDF rendering modes 🔥.\n- Webhook notification after PDF rendered (for async flow) 🚀\n- Built-in UI-console to manage \u0026 review the templates \u0026 files (for internal use) 🔋.\n- Horizontal scaling when traffic goes high? DocKing got that 😉.\n\nCheck out our planned features here: [The DocKing Project](https://github.com/orgs/shipsaas/projects/1)\n\n## Diagram of how it works\n\n![DocKing](./docs/img/full-picture.png)\n\nFrom the diagram above, DocKing is standing as a \"shared-microservice\".\n\n- Billing Service can manage their bill templates and render the PDFs.\n- Order Service can manage their order templates and render the PDFs.\n- Contract Service can manage their contract templates and render the PDFs.\n- ...\n\nAwesome, IKR?\n\n## The Awesome Console UI\n\nDocKing ships the Built-in Console with awesome editor \u0026 features. Help you and the team to collaborate and\nmanage everything easily.\n\n![DocKing's Console UI](https://iili.io/H4QDEJe.png)\n\nLearn more: [DocKing's Console UI](https://docking.shipsaas.tech/getting-started/console-ui)\n\n## DocKing uses\n- PHP 8.2\n- Laravel 10\n- Any database (MySQL, PostgreSQL or SQLite - your choice)\n  -  Personal preference: MySQL 8\n- Vue 3\n- Tailwind CSS\n\n### PDF Rendering Services\n- Gotenberg ⭐️\n- wkHTMLtoPDF ✅\n- mPDF 🧰 (available since v1.1.0)\n\n## Tests\n\n- Unit Tests to cover all functions \u0026 methods ❇️\n- Integration Tests to test against REAL PDF ENGINES:\n  - Gotenberg ✅\n  - WkHtmlToPdf ✅\n  - mPDF ✅\n- E2E Tests to validate REAL WORLD API CALLs \u0026 Rendering Async Flow\n\n## LICENSE\n\nMIT LICENSE\n\n## Development \u0026 Contribution Guidelines\n- Please follow PSR-1 \u0026 PSR-12 coding conventions\n- Unit/Integration testing is a must\n\nThank you very much for your contributions!\n\n## Contributors\n\nShipSaaS x Seth Phat \u0026 Contributors.\n\n## Copyright\n\nCopyright ©️ 2023 by ShipSaaS x Seth Phat.\n","funding_links":[],"categories":["PHP","Applications","Creation and production"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipsaas%2Fdocking","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshipsaas%2Fdocking","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshipsaas%2Fdocking/lists"}