2
2
3
3
[ ![ Build & Test (PHP 8.2)] ( https://github.com/shipsaas/docking/actions/workflows/build.yml/badge.svg )] ( https://github.com/shipsaas/docking/actions/workflows/build.yml )
4
4
[ ![ Integration Tests] ( https://github.com/shipsaas/docking/actions/workflows/integration.yml/badge.svg )] ( https://github.com/shipsaas/docking/actions/workflows/integration.yml )
5
+ [ ![ E2E Tests] ( https://github.com/shipsaas/docking/actions/workflows/e2e.yml/badge.svg )] ( https://github.com/shipsaas/docking/actions/workflows/e2e.yml )
5
6
[ ![ codecov] ( https://codecov.io/gh/shipsaas/docking/branch/main/graph/badge.svg?token=FAZ9899IPW )] ( https://codecov.io/gh/shipsaas/docking )
6
7
7
8
<p align =" center " width =" 100% " >
8
9
<img src="https://raw.githubusercontent.com/shipsaas/docking/main/docs/img/logo.png">
9
10
</p >
10
11
11
- DocKing is a document management microservice that handles templates and renders them in PDF format, all in one place.
12
+ DocKing is a document management service/ microservice that handles templates and renders them in PDF format, all in one place.
12
13
13
- You can utilize DocKing as a shared microservice, which can be integrated into any service .
14
+ You can utilize DocKing as a shared microservice, which can be integrated & used in any services from your big product .
14
15
15
16
Documentation: [ DocKing] ( https://docking.shipsaas.tech )
16
17
18
+ DocKing is well-tested & production-ready 😉🏎️🚀
19
+
17
20
## LIVE DEMO 🔥
18
21
19
22
URL: https://docking-demo.shipsaas.tech/
@@ -25,15 +28,19 @@ Console: https://docking-demo.shipsaas.tech/console#/
25
28
- Drivers:
26
29
- Gotenberg: Yes, use the Live Demo Instance (from Gotenberg.dev)
27
30
- WkHtmlToPdf: Yes, without any extensions or fonts.
28
- - Most of the features are disabled. You can only view & preview PDFs in multiple modes.
31
+ - mPDF: Yes, without any extensions or fonts.
32
+ - Most of the features are disabled. You can only view & preview PDFs in multiple drivers.
29
33
30
34
## Features 🚀
31
- - Manage your document templates 📰🧾.
32
- - Render HTML based on your desired data for a specific template, then export it as PDF 🏃.
35
+ - Manage all of your document templates just in one place 📰🧾.
36
+ - Dynamically render & export PDF from your desired data 🏃.
33
37
- Supports multiple state-of-the-art PDF Engines 🍻.
38
+ - Supports sync & async PDF rendering modes 🔥.
34
39
- Webhook notification after PDF rendered (for async flow) 🚀
35
- - Built-in UI-console to manage the templates & files (for internal use) 🔋.
36
- - DocKing can perfectly fit for the horizontal scaling based on your needs 😉.
40
+ - Built-in UI-console to manage & review the templates & files (for internal use) 🔋.
41
+ - Horizontal scaling when traffic goes high? DocKing got that 😉.
42
+
43
+ Check out our planned features here: [ The DocKing Project] ( https://github.com/orgs/shipsaas/projects/1 )
37
44
38
45
## Diagram of how it works
39
46
@@ -68,7 +75,7 @@ Awesome, IKR?
68
75
- Gotenberg ✅
69
76
- WkHtmlToPdf ✅
70
77
- mPDF ✅
71
- - E2E Tests to validate REAL WORLD API CALLs
78
+ - E2E Tests to validate REAL WORLD API CALLs & Rendering Async Flow
72
79
73
80
## LICENSE
74
81
0 commit comments