Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rimiti/invoice-it
:page_with_curl: Generate your orders or your invoices and export them in html, pdf or buffer easily.
https://github.com/rimiti/invoice-it
generator html invoice invoice-template module node order order-template pdf
Last synced: about 5 hours ago
JSON representation
:page_with_curl: Generate your orders or your invoices and export them in html, pdf or buffer easily.
- Host: GitHub
- URL: https://github.com/rimiti/invoice-it
- Owner: rimiti
- License: mit
- Created: 2017-05-02T11:37:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T16:43:15.000Z (about 1 year ago)
- Last Synced: 2024-10-23T17:16:00.621Z (15 days ago)
- Topics: generator, html, invoice, invoice-template, module, node, order, order-template, pdf
- Language: JavaScript
- Homepage: https://dimsolution.com/blog/2018-05-29/how-to-easily-generate-order-invoice-pdf-file/
- Size: 1.52 MB
- Stars: 92
- Watchers: 4
- Forks: 33
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# invoice-it
[![Dependencies][prod-dependencies-badge]][prod-dependencies]
[![Code Climate score][codeclimate-score-badge]][codeclimate-score]
[![Code Climate coverage][coverage-badge]][coverage]
[![Code Climate coverage][codeclimate-issues-badge]][codeclimate-issues]
[![Build Status][travis-badge]][travis-ci]
[![MIT License][license-badge]][LICENSE]
[![PRs Welcome][prs-badge]][prs]
Generate your orders and you invoices and export them easily.
If you want some examples, check tests.
## Install
```
$ npm install @rimiti/invoice-it --save
```
## Features
- Generate order / invoice
- Export to HTML / PDF / Stream
- Easy to use it
- Robust implementation with good unit test coverage.
## Demonstration
## Usage
### Importation
**From import**
```javascript
import invoiceIt from '@rimiti/invoice-it';
```
**From require**
```javascript
const invoiceIt = require('@rimiti/invoice-it').default;
```
### Order
To generate an order:
```js
import invoiceIt from '@rimiti/invoice-it';
const recipient = {
company_name: 'Receiver company',
first_name: 'Will',
last_name: 'Jameson',
street_number: '20',
street_name: 'Rue Victor Hugo',
zip_code: '77340',
city: 'Pontault-Combault',
country: 'France',
phone: '06 00 00 00 00',
mail: '[email protected]'
};
const emitter = {
name: 'Dim Solution',
street_number: '15',
street_name: 'Rue Jean Jaures',
zip_code: '75012',
city: 'Paris',
country: 'France',
phone: '01 00 00 00 00',
mail: '[email protected]',
website: 'www.dimsolution.com'
};
const order = invoiceIt.create(recipient, emitter);
```
You can also use getter / setters like that
```js
const order = invoiceIt.create();
order.recipient.company_name = 'Receiver company';
order.recipient.first_name = 'Will';
order.recipient.last_name = 'Jameson';
order.recipient.street_number = '20';
order.recipient.street_name = 'Rue Victor Hugo';
order.recipient.zip_code = '77340';
order.recipient.city = 'Pontault-Combault';
order.recipient.country = 'France';
order.recipient.phone = '06 00 00 00 00';
order.recipient.mail = '[email protected]';
order.emitter.name = 'Dim Solution';
order.emitter.street_number = '15';
order.emitter.street_name = 'Rue Jean Jaures';
order.emitter.zip_code = '75012';
order.emitter.city = 'Paris';
order.emitter.country = 'France';
order.emitter.phone = '01 00 00 00 00';
order.emitter.mail = '[email protected]';
order.emitter.website = 'www.dimsolution.com';
```
Return order object
```js
order.getOrder();
```
Return html order
```js
order.getOrder().toHTML();
```
Save html order into file (default filepath: 'order.html')
```js
order.getOrder().toHTML().toFile('./order.html')
.then(() => {
console.log('HTML file created.');
});
```
Save html order into file (default filepath: 'order.pdf')
```js
order.getOrder().toPDF().toFile('./order.pdf')
.then(() => {
console.log('PDF file created.');
});
```
### Invoice
To generate an invoice:
```js
import invoiceIt from '@rimiti/invoice-it';
const recipient = {
company_name: 'Receiver company',
first_name: 'Will',
last_name: 'Jameson',
street_number: '20',
street_name: 'Rue Victor Hugo',
zip_code: '77340',
city: 'Pontault-Combault',
country: 'France',
phone: '06 00 00 00 00',
mail: '[email protected]'
};
const emitter = {
name: 'Dim Solution',
street_number: '15',
street_name: 'Rue Jean Jaures',
zip_code: '75012',
city: 'Paris',
country: 'France',
phone: '01 00 00 00 00',
mail: '[email protected]',
website: 'www.dimsolution.com'
};
const invoice = invoiceIt.create(recipient, emitter);
```
You can also use getter / setters like that
```js
const invoice = invoiceIt.create();
invoice.recipient.company_name = 'Receiver company';
invoice.recipient.first_name = 'Will';
invoice.recipient.last_name = 'Jameson';
invoice.recipient.street_number = '20';
invoice.recipient.street_name = 'Rue Victor Hugo';
invoice.recipient.zip_code = '77340';
invoice.recipient.city = 'Pontault-Combault';
invoice.recipient.country = 'France';
invoice.recipient.phone = '06 00 00 00 00';
invoice.recipient.mail = '[email protected]';
invoice.emitter.name = 'Dim Solution';
invoice.emitter.street_number = '15';
invoice.emitter.street_name = 'Rue Jean Jaures';
invoice.emitter.zip_code = '75012';
invoice.emitter.city = 'Paris';
invoice.emitter.country = 'France';
invoice.emitter.phone = '01 00 00 00 00';
invoice.emitter.mail = '[email protected]';
invoice.emitter.website = 'www.dimsolution.com';
```
Return invoice object
```js
invoice.getInvoice();
```
Return html invoice
```js
invoice.getInvoice().toHTML();
```
Save html invoice into file (default filepath: 'invoice.html')
```js
invoice.getInvoice().toHTML().toFile('./invoice.html')
.then(() => {
console.log('HTML file created.');
});
```
Save html invoice into file (default filepath: 'invoice.pdf')
```js
invoice.getInvoice().toPDF().toFile('./invoice.pdf')
.then(() => {
console.log('PDF file created.');
});
```
Add custom fields to invoice
```js
const paymentId = {
key: 'invoice_header_paymentId_value',
value: paymentRef
};
const phrases = ['invoice_header_payment_reference', paymentId];
invoice.getInvoice(phrases).toPDF()
```
### Customization
All below globals attributes are totally customizable from the `.configure()` method or from `setters`:
**From .configure()**
The configure method can override all default attributes presents [in this file](https://github.com/rimiti/invoice-it/blob/master/src/index.js).
Customization example:
To generate and export in PDF an invoice with:
- Logo url: http://example.com/logo.png
- Date format: YYYY-MM-DD
- Your invoice pattern: INVOICE-1901_00001
- Invoice note: It's my custom node!
```js
import invoiceIt from '@rimiti/invoice-it';
invoiceIt.configure({
global: {
logo: 'http://example.com/logo.png',
invoice_reference_pattern: '$prefix{INVOICE}$date{YYMM}$separator{_}$id{00000}',
invoice_note: 'It\'s my custom node!',
date_format: 'YYYY-MM-DD',
},
});
const recipient = {
company_name: 'Receiver company',
first_name: 'Will',
last_name: 'Jameson',
street_number: '20',
street_name: 'Rue Victor Hugo',
zip_code: '77340',
city: 'Pontault-Combault',
country: 'France',
phone: '06 00 00 00 00',
mail: '[email protected]'
};
const emitter = {
name: 'Dim Solution',
street_number: '73',
street_name: 'Rue Jean Jaures',
zip_code: '75012',
city: 'Paris',
country: 'France',
phone: '01 00 00 00 00',
mail: '[email protected]',
website: 'www.dimsolution.com'
};
const invoice = invoiceIt.create(recipient, emitter);
invoice.id = 1;
order.getInvoice().toPDF().toFile();
```
**From setters**
```js
import invoiceIt from '@rimiti/invoice-it';
const recipient = {
company_name: 'Receiver company',
first_name: 'Will',
last_name: 'Jameson',
street_number: '20',
street_name: 'Rue Victor Hugo',
zip_code: '77340',
city: 'Pontault-Combault',
country: 'France',
phone: '06 00 00 00 00',
mail: '[email protected]'
};
const emitter = {
name: 'Dim Solution',
street_number: '73',
street_name: 'Rue Jean Jaures',
zip_code: '75012',
city: 'Paris',
country: 'France',
phone: '01 00 00 00 00',
mail: '[email protected]',
website: 'www.dimsolution.com'
};
const invoice = invoiceIt.create(recipient, emitter);
invoice.global.logo = 'http://example.com/logo.png';
invoice.global.invoice_reference_pattern = '$prefix{INVOICE}$date{YYMM}$separator{_}$id{00000}';
invoice.global.invoice_note = 'It\'s my custom node!';
invoice.global.date_format = 'YYYY-MM-DD';
invoice.id = 1;
order.getInvoice().toPDF().toFile();
```
### i18n
To add more language:
```js
import invoiceIt from '@rimiti/invoice-it';
invoiceIt.configure({
language: {
locales: ['en', 'pl'],
directory: `${__dirname}/path/to/locales`,
defaultLocale: 'en'
}
});
```
## Scripts
Run using npm run command.
clean - remove coverage data, Jest cache and transpiled files,
test - run tests with coverage,
test:watch - interactive watch mode to automatically re-run tests,
build - compile source files,
build:watch - interactive watch mode, compile sources on change.
## License
MIT © [Dimitri DO BAIRRO](https://github.com/rimiti/invoice-it/blob/master/LICENSE)
[prod-dependencies-badge]: https://david-dm.org/rimiti/invoice-it/status.svg
[prod-dependencies]: https://david-dm.org/rimiti/invoice-it
[codeclimate-score-badge]: https://codeclimate.com/github/rimiti/invoice-it/badges/gpa.svg
[codeclimate-score]: https://codeclimate.com/github/rimiti/invoice-it
[coverage-badge]: https://codecov.io/gh/rimiti/invoice-it/branch/master/graph/badge.svg
[coverage]: https://codecov.io/gh/rimiti/invoice-it
[codeclimate-issues-badge]: https://codeclimate.com/github/rimiti/invoice-it/badges/issue_count.svg
[codeclimate-issues]: https://codeclimate.com/github/rimiti/invoice-it
[travis-badge]: https://travis-ci.org/rimiti/invoice-it.svg?branch=master
[travis-ci]: https://travis-ci.org/rimiti/invoice-it
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[license]: https://github.com/rimiti/invoice-it/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com