![\"CarboneJS\"](\"https://carbone.io/img/favicon.png\")
\n \n\n \n \n \n
\n\n \n \n \n
\n \n \n
\n
\n \n \n \n \n
\n \n \n
\n \n \n
\n \n
Fast, Simple and Powerful report generator in any format PDF, DOCX, XLSX, ODT, PPTX, ODS, XML, CSV using your JSON data as input !
\n\nREADME language: 🇨🇳 [简体ä¸æ–‡](./doc/README.zh-cn.md), 🇺🇸 [English](README.md)\n\n## Table of content\n\n\n\n- [Features](#features)\n- [How it works?](#how-it-works)\n- [Minimum Requirements](#minimum-requirements)\n - [Optional](#optional)\n- [Getting started](#getting-started)\n - [Basic sample](#basic-sample)\n - [PDF generation, document conversion](#pdf-generation-document-conversion)\n- [More examples](#more-examples)\n- [API Reference](#api-reference)\n- [Command line tools](#command-line-tools)\n- [Issues](#issues)\n- [Roadmap](#roadmap)\n- [Performance](#performance)\n- [Licenses and editions](#licenses-and-editions)\n- [Philosophy](#philosophy)\n- [Contributors](#contributors)\n\n\n\n## Features\n\n - **Extremely simple** : Use only LibreOfficeâ„¢, OpenOfficeâ„¢ or Microsoft Officeâ„¢ to draw your report\n - **Unlimited design** : The limit is your document editor: pagination, headers, footers, tables...\n - **Convert documents** : thanks to the integrated document converter\n - **Unique template engine** : Insert JSON-like markers `{d.companyName}` directly in your document\n - **Flexible** : Use any XML documents as a template: docx, odt, ods, xlsx, html, pptx, odp, custom xml files...\n - **Future-proof** : A powerful XML-agnostic algorithm understands what to do without knowing XML document specifications\n - **Multilingual** : One template, multiple languages. Update translation files automatically\n - **Format data** : Use built-in date and number formatters or create your own in Javascript\n - **Fast** : Manage multiple LibreOffice threads for document conversion, optimized code generation for each report\n\n## How it works?\n\nCarbone is a mustache-like template engine `{d.companyName}`.\n\nTemplate language documentation : https://carbone.io/documentation.html\n\n- The template can be any XML-document coming from LibreOfficeâ„¢ or Microsoft Officeâ„¢ (ods, docx, odt, xslx...)\n- The injected data must be a JSON object or array, coming directly from your existing APIs for example\n\nCarbone analyzes your template and inject data in the document. The generated document can be exported as is, or converted to another format (PDF, ...) using LibreOffice if it is installed on the system.\nCarbone is working only on the server-side.\n\n\n## Minimum Requirements\n\n- NodeJS 10.x+\n- Runs on OSX, Linux (servers and desktop), and Windows\n\n#### Optional\n\n- LibreOffice server if you want to use the document converter and generate PDF. Without LibreOffice, you can still generate docx, xlsx, pptx, odt, ods, odp, html as long as your template is in the same format.\n\n\n## Getting started\n\n### Basic sample\n\n1 - Install it\n\n```bash\n npm install carbone\n```\n\n2 - Copy-paste this code in a new JS file, and execute it with node\n\n```javascript\n const fs = require('fs');\n const carbone = require('carbone');\n\n // Data to inject\n var data = {\n firstname : 'John',\n lastname : 'Doe'\n };\n\n // Generate a report using the sample template provided by carbone module\n // This LibreOffice template contains \"Hello {d.firstname} {d.lastname} !\"\n // Of course, you can create your own templates!\n carbone.render('./node_modules/carbone/examples/simple.odt', data, function(err, result){\n if (err) {\n return console.log(err);\n }\n // write the result\n fs.writeFileSync('result.odt', result);\n });\n```\n\n### PDF generation, document conversion\n\nCarbone uses efficiently LibreOffice to convert documents. Among all tested solutions, it is the most reliable and stable one in production for now.\n\nCarbone does a lot of thing for you behind the scene:\n\n- starts LibreOffice in \"server-mode\": headless, no User Interface loaded\n- manages multiple LibreOffice workers to maximize performance (configurable number of workers)\n- automatically restarts LibreOffice worker if it crashes or does not respond\n- job queue, re-try conversion three times if something bad happen\n\n\n##### 1 - install LibreOffice\n\n###### on OSX\n\n- Install LibreOffice normally using the stable version from https://www.libreoffice.org/\n\n###### on Ubuntu Server & Ubuntu desktop\n\n> Be careful, LibreOffice which is provided by the PPA libreoffice/ppa does not bundled python (mandatory for Carbone). The best solution is to download the LibreOffice Package from the official website and install it manually:\n\n```bash\n # remove all old version of LibreOffice\n sudo apt remove --purge libreoffice*\n sudo apt autoremove --purge\n\n # Download LibreOffice debian package. Select the right one (64-bit or 32-bit) for your OS.\n # Get the latest from http://download.documentfoundation.org/libreoffice/stable\n # or download the version currently \"carbone-tested\":\n wget https://downloadarchive.documentfoundation.org/libreoffice/old/7.0.4.2/deb/x86_64/LibreOffice_7.0.4.2_Linux_x86-64_deb.tar.gz\n\n # Install required dependencies on ubuntu server for LibreOffice 7.0+\n sudo apt install libxinerama1 libfontconfig1 libdbus-glib-1-2 libcairo2 libcups2 libglu1-mesa libsm6\n\n # Uncompress package\n tar -zxvf LibreOffice_7.0.4.2_Linux_x86-64_deb.tar.gz\n cd LibreOffice_7.0.4.2_Linux_x86-64_deb/DEBS\n\n # Install LibreOffice\n sudo dpkg -i *.deb\n\n # If you want to use Microsoft fonts in reports, you must install the fonts\n # Andale Mono, Arial Black, Arial, Comic Sans MS, Courier New, Georgia, Impact,\n # Times New Roman, Trebuchet, Verdana,Webdings)\n sudo apt install ttf-mscorefonts-installer\n\n # If you want to use special characters, such as chinese ideograms, you must install a font that support them\n # For example:\n sudo apt install fonts-wqy-zenhei\n```\n\n##### 2 - generate PDF\n\nAnd now, you can use the converter, by passing options to render method.\n\n> Don't panic, only the first conversion is slow because LibreOffice must starts\n> Once started, LibreOffice stays on to make new conversions faster\n\n```javascript\n var data = {\n firstname : 'John',\n lastname : 'Doe'\n };\n\n var options = {\n convertTo : 'pdf' //can be docx, txt, ...\n };\n\n carbone.render('./node_modules/carbone/examples/simple.odt', data, options, function(err, result){\n if (err) return console.log(err);\n fs.writeFileSync('result.pdf', result);\n process.exit(); // to kill automatically LibreOffice workers\n });\n```\n\n\n## More examples\n\n##### Nested repetition in a docx document and spreadsheet\n\n```javascript\n\n var data = [\n {\n movieName : 'Matrix',\n actors : [{\n firstname : 'Keanu',\n lastname : 'Reeves'\n },{\n firstname : 'Laurence',\n lastname : 'Fishburne'\n },{\n firstname : 'Carrie-Anne',\n lastname : 'Moss'\n }]\n },\n {\n movieName : 'Back To The Future',\n actors : [{\n firstname : 'Michael',\n lastname : 'J. Fox'\n },{\n firstname : 'Christopher',\n lastname : 'Lloyd'\n }]\n }\n ];\n\n carbone.render('./node_modules/carbone/examples/movies.docx', data, function(err, result){\n if (err) return console.log(err);\n fs.writeFileSync('movies_result.docx', result);\n });\n\n carbone.render('./node_modules/carbone/examples/flat_table.ods', data, function(err, result){\n if (err) return console.log(err);\n fs.writeFileSync('flat_table_result.ods', result);\n });\n```\n\n\n## API Reference\n\nTo check out the **[api reference](https://carbone.io/api-reference.html#carbone-js-api)** and the **[documentation](https://carbone.io/documentation)**, visit [carbone.io](http://carbone.io).\n\n\n## Command line tools\n\nTo checkout out the Carbone CLI documentation, visit [carbone.io](https://carbone.io/api-reference.html#cli)\n\n## Issues\n\nIf you're facing any issues, search a similar issue to ensure it doesn't already exist on [Github](https://github.com/carboneio/carbone/issues). Otherwhise, [create an issue to help us](https://github.com/carboneio/carbone/issues/new/choose).\n\n## Roadmap\n\nThe roadmap is pinned on the github issues list.\n\n## Performance\n\nReport generation speed (without network latency), using a basic one-page DOCX template:\n\n - ~ `10 ms / report` without document conversion (analyzing, injection, rendering)\n - ~ `50 ms / report` with a PDF conversion (100 loops, 3 LibreOffice workers, without cold-start)\n\nOn a MacBook Pro Mid-2015, 2,2 Ghz i7, 16Go.\n\n## Licenses and editions\n\nThere are two editions of Carbone:\n\n- Carbone Community Edition is available freely under the **Apache v2 license**\n- Carbone Enterprise Edition (hosted and on-premise) includes extra features like a user interface.\n\nWe want to follow the model of Gitlab. **The free version must be and must stay generous.**\n\n\n## Philosophy\n\n> Our ultimate goal\n\n2% percent of our hosted solution revenues will go to charity in three domains: open source software we love, education and environment.\n\nWe already know that beneficiaries will be, at least :heart:\n- LibreOffice foundation\n- PostgreSQL foundation\n- An innovative child school in France\n\n## Contributors\n\nThanks to all Carbone contributors (random order)\n\n - Florian Bezagu\n - Matthieu Robin\n - Arnaud Lelièvre\n - Maxime Vincent\n - Enzo Ghemard\n - Jordan Nourry\n - Etienne Rouillard\n - Guillaume Chevaux\n - Fabien Bigant\n - Maxime Magne\n - Vincent Bertin\n - Léo Labruyère\n - Aurélien Kermabon\n - [Steeve Payraudeau](https://github.com/steevepay)","readmeFilename":"README.md"}