document-templating-service GitHub Details, Stars and Alternatives | OpenRepoFinder
PapiHack / repository
document-templating-service
A simple and lightweight service that allows you to process your word document with the variables defined therein by injecting the necessary data that you will provide and return the result in PDF
A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
72
Community adoption25% weight
31
Maintenance state20% weight
100
License clarity10% weight
100
Project information10% weight
75
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
README preview
🚀 Document Template Processing Service 🚀
This is a simple and lightweight microservice that allow you to process your Word documents with a templating system, in order to hydrate it by injecting data or variables defined in it and get back its associated PDF result.
For transforming the docx result to PDF you'll need have an instance of Gotenberg up and running and provide its ROOT URL as an environment variable to the microservice.
Installation
First and foremost you'll need to have an instance of Gotenberg. You can easily have one by running the following docker command :
docker run --name gotenberg -d -p 3000:3000 gotenberg/gotenberg:7
After this step done, you have the two (2) options in order to run this service :
Direct run by following the steps below :
Rename the file .env.example at the root level of this project by simply .env
Set the value of the GOTENBERG_API_URL environment variable defined in it with yours (in our example => http://localhost:3000)
Install the necessary dependencies by running :
pip install -r requirements.txt (you can create virtual env if you want it)
If you are lazy like me 😄, you can setup the project by just running the following command :
docker-compose up -d
And stop all the service with :
docker-compose stop
Or stop and remove all the service with :
docker-compose down
Up & Running with Kubernetes
If you want to deploy this project on your kubernetes cluster, you can inspect and/or edit the manifest files available in the
k8s directory before apply them.
Start by creating the namespace named utils by running :
kubectl apply -f k8s/namespace.yaml
Then, you can deploy the necessary components by running :
For now, you have an endpoint named /api/v1/process-template-document that will allow you to make a POST HTTP REQUEST by sending two (2) required parameters :
The file parameter that contains your Word Document Template
The data parameter that is a JSON object with data or variable that we are going to inject in the file parameter
As a response, you'll get back its corresponding PDF file as a result.
Example
🚨 Cautions for Cloud Run 🚨
If you plan to run this on cloud, please change the gotenberg docker image with gotenberg/gotenberg:7-cloudrun or thecodingmachine/gotenberg:7-cloudrun in docker-compose.yaml file. This will allow you to save cost and so on.
