https://github.com/pkokki/documentcreator

An opinionated solution for creating documents from JSON objects (API payloads) based on Word templates and Excel formula configuration.
https://github.com/pkokki/documentcreator

document-generation excel-formula expression-evaluator math-expression-evaluator

Last synced: 5 months ago
JSON representation

An opinionated solution for creating documents from JSON objects (API payloads) based on Word templates and Excel formula configuration.

Host: GitHub
URL: https://github.com/pkokki/documentcreator
Owner: pkokki
License: mit
Created: 2020-03-30T22:22:39.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2023-01-07T18:54:18.000Z (over 3 years ago)
Last Synced: 2025-08-21T23:03:35.299Z (10 months ago)
Topics: document-generation, excel-formula, expression-evaluator, math-expression-evaluator
Language: C#
Homepage: https://doc-creator.azurewebsites.net/
Size: 5.32 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 44
Metadata Files:
- Readme: README.md
- License: LICENSE.TXT

Awesome Lists containing this project

README

          # Document Creator

An opinionated solution for creating documents from JSON objects (API payloads) based on Word templates and Excel formula configuration.

[![.NET Core](https://github.com/pkokki/DocumentCreator/workflows/.NET%20Core/badge.svg)](https://github.com/pkokki/DocumentCreator/actions?query=workflow%3A%22.NET+Core%22)

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/pkokki/DocumentCreator)](https://github.com/pkokki/DocumentCreator/releases) 

[![GitHub commits since latest release (by date including pre-releases)](https://img.shields.io/github/commits-since/pkokki/DocumentCreator/0.3.0-alpha/master?include_prereleases)](https://github.com/pkokki/DocumentCreator/commits/master) 

[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/pkokki/DocumentCreator)](https://github.com/pkokki/DocumentCreator) 

[![GitHub issues](https://img.shields.io/github/issues/pkokki/DocumentCreator)](https://github.com/pkokki/DocumentCreator/issues)

## Getting Started

Create Word documents and HTML pages by combining Word templates (documents with content controls) and JSON data via transformations defined as Excel formulas. 

* Try the [quickstart](https://doc-creator.azurewebsites.net/#/) to create a document in four steps.

* View the [API documentation](https://doc-creator.azurewebsites.net/swagger/)

## Transformation examples

[![Nuget](https://img.shields.io/nuget/v/JsonExcelExpressions)](https://www.nuget.org/packages/JsonExcelExpressions/)

Given the data

```json

{

    "x1": 10,

    "x2": 2,

    "x3": { "firstname": "john", "surname": "smith" },

    "x4": [100, 200, 300, 400],

    "x5": {

        "y1": "A quick brown fox jumps over the lazy dog",

        "y2": "brown",

        "y3": "#red#",

        "y4": [ 1, 2, 3]

    }

}

```

we can evaluate the following expressions

| expression | result (in el-GR culture) |

| --- | --- | 

| `8 / 2 * (2 + 2)` | 16 |

| `x1 * x2 - x1 / x2` | 15 |

| `CONCATENATE(x3.firstname, " ", x3.surname)` | john smith |

| `SUM(x4) * 24%` | 240,00 |

| `x4` | ['100','200','300','400'] |

| `PROPER(REPLACE(x5.y1, SEARCH(x5.y2, x5.y1), LEN(x5.y2), x5.y3))` | A Quick #Red# Fox Jumps Over The Lazy Dog |

| `IF(x1 + IFNA(missing.path, x2) > 10, ">10", "<=10")` | >10 |

| `DATE(2020, 4, 28) + x5.y4[1]` | 30/4/2020 |

| `IF(__A1 > __A2, UPPER(__A3), "?")` | JOHN SMITH |

See the [full list](https://github.com/pkokki/DocumentCreator/wiki/Supported-Excel-Functions) of supported Excel functions. Suggest the implementation of missing functions by [opening an issue](https://github.com/pkokki/DocumentCreator/issues/new).

You can test it live [here](https://doc-creator.azurewebsites.net/#/expressions). 

## Installation

TBD

## Built with

### API

* [ASP.NET Core](https://github.com/dotnet/aspnetcore) 

* [Open XML SDK](https://github.com/OfficeDev/Open-XML-SDK) - to generate documents and extract content from Word and Excel files

* [Open XML PowerTools](https://github.com/EricWhiteDev/Open-Xml-PowerTools) - to convert Word documents to HTML/CSS

### Web client

* [Angular](https://github.com/angular/angular)

* [Angular Material](https://github.com/angular/components)

### Tests

* [xUnit.net](https://github.com/xunit/xunit)

* [Moq](https://github.com/moq/moq4)

## Contributing

Contributions are welcome. Please contact the [project maintainer](https://github.com/pkokki).

## Versions

For the versions available, see the [tags on this repository](https://github.com/pkokki/DocumentCreator/tags). 

## Authors

* **Panos** - *Initial work* - [pkokki](https://github.com/pkokki)

## License

This project is licensed under the MIT License - see the [LICENSE.TXT](LICENSE.TXT) file for details

## Credits

* Tim Hall, [JSON conversion and parsing for VBA](https://github.com/VBA-tools/VBA-JSON)

* E. W. Bachtal, [Excel Formula Parsing in C#](https://ewbi.blogs.com/develops/2007/03/excel_formula_p.html)

* Eric White, [Open XML PowerTools](https://github.com/EricWhiteDev)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/pkokki/documentcreator

Awesome Lists containing this project

README