https://github.com/kode-rex/mustache-reports
Reference implementation of clean architecture using docx templater to render docx to pdf reports.
https://github.com/kode-rex/mustache-reports
clean-architecture docx docxtemplater dotnetcore libreoffice pdf reporting
Last synced: about 1 year ago
JSON representation
Reference implementation of clean architecture using docx templater to render docx to pdf reports.
- Host: GitHub
- URL: https://github.com/kode-rex/mustache-reports
- Owner: Kode-Rex
- Created: 2017-07-15T10:09:27.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T20:21:09.000Z (over 3 years ago)
- Last Synced: 2025-01-13T00:29:10.253Z (over 1 year ago)
- Topics: clean-architecture, docx, docxtemplater, dotnetcore, libreoffice, pdf, reporting
- Language: C#
- Homepage:
- Size: 29.7 MB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mustache-Reports
An example of using the mustache reports server code base to generate reports in docx using node and LibreOffice to convert to PDF.
_You will need to make sure both node and libreoffice 5 are installed on your computer to run this example._
_This example is rough and ready, please log an issue if you require assistance._
_There are now nuget packages which contain the core report rendering logic, removing the need to manually manage node packages in your solution_.
The word file generations happens using [docx-templater](https://docxtemplater.com/) and [xlsx-template](https://www.npmjs.com/package/xlsx-template). It is written in node and uses mustache templating to populate the report.
You will need to model your report data in JSON for the templating to work, and because docx-templater is so awesome you can use [angular expression](https://docxtemplater.readthedocs.io/en/latest/angular_parse.html) to modify reporting data at runtime. It is unknown if xlsx-template also supports angular expressions, if not I will add it soon.
Have a look at _reportRender.js_ ReportRender.prototype.configureAngularExpressions method - you can add your own customer angular expressions here.
_Please note there are currently plans to abstract this allowing your to specify your own angular expressions file without needing to modify the core package. This is one of my main focuses_
I have also added a custom image handling code to allow for base64 encoded image data to be part of the JSON payload - have a look at _reportRender.js_ ReportRender.prototype.getOptions method for more detail.
_Please note this is now a paid for feature of docx-templater, good thing we got the last version of the open source image module_
This example makes use of TddBuddy's Clean Architecture and Synchronous Process Execution packages.
+ Synchronous Process Runner - DotNetCore
- Install-Package TddBuddy.Synchronous.Process.Runner.DotNetCore
- Source @ https://github.com/StoneAgeTechnologies/Synchronous-Process-Runner-DotNetCore
+ Clean Architecture Domain - DotNetCore
- Install-Package TddBuddy.CleanArchitecture.Domain.DotNetCore
- Source @ https://github.com/StoneAgeTechnologies/CleanArchitecture-DotNetCore.git