Skip to content

README.md

Latest commit

 

History

History
77 lines (50 loc) · 2.54 KB

README.md

File metadata and controls

77 lines (50 loc) · 2.54 KB

node-microinvoice2

This is a fork of node-microinvoice located at https://github.com/baptistejamin/node-microinvoice/.

This fork is partially maintained to remove

  1. Vulnerabilities.
  2. Deprecated code.

600 Dependent packages have been removed. 74 Vulnerabilities have been removed. 1 package function has been replaced (transliteration to unicoded).

NPM Downloads

Original Package & Features

-- Nothing functional was contributed. The original package remains available and is located here:

NPM Downloads

Fast & elegant PDF invoice generator for Node using PDFKit.

  • What Microinvoice does?
  • It builds invoices that looks good
  • Generates a PDF in less than 30ms
  • Custom Styling & Text
  • Covers extended charsets like Russian, Polish (native PDF fonts only supports Latin)
  • Transliterate to Latin when charset is not supported (Chinese, Arabic)
  • How invoices looks like ?

Example

Why another invoice generator

This project was made for our own company Crisp. We are generating everymonth thousands of HTML invoices. Given this scale, using Puppeteer for generating HTML to PDF would be very inefficient.

As everyday, our customers were asking for PDF invoices as some accounting softwares automatically fetch invoices from emails. I could really understand their frustration. At the end, why generating PDF should be easy?

Who uses it?

Crisp

👋 You use microinvoice and you want to be listed there? Contact me.

How to install?

Include microinvoice2 in your package.json dependencies.

Alternatively, you can run npm install microinvoice2 --save.

How to use?

Import the module in your code:

var MicroInvoice = require("microinvoice");

let myInvoice = new MicroInvoice({
  // Use example from examples/index.js
});
// Render invoice as PDF
myInvoice.generate("example.pdf").then(() => {
  console.log("Invoice saved");
});