d-danfe/README.md

Visualizador de DANFE em HTML

# djf-danfe
[![Build Status](https://travis-ci.org/djalmaoliveira/djf-danfe.svg?branch=master)](https://travis-ci.org/djalmaoliveira/djf-danfe) ![Version](https://img.shields.io/npm/v/djf-danfe.svg)

Visualizador de DANFE (Documento Auxiliar Da Nota Fiscal Eletrônica) em HTML.

## Preparação

### Pré-requisitos

NodeJS 8.x

### Instalação

```
npm i -S douglasselias/djf-danfe
```

### Exemplos

```
const djf_danfe = require('djf-danfe')
const danfe = djf_danfe.fromXML('conteudo XML')
console.log(danfe.toHtml())
```

[Outros exemplos de uso](https://github.com/djalmaoliveira/djf-danfe/tree/master/test/index.js)


## Especificações

### Funções

* Criar representação do DANFE em HTML baseado somente em um arquivo XML existente.
* Criar a representação somente no formato retrato.
* Possui contagem do número de folhas.

### Limitações

* Não converte para outros formatos como pdf e imagens (basta usar um conversor externo, ex.: [node-wkhtmltopdf](https://github.com/devongovett/node-wkhtmltopdf)).
* Não valida os valores dos campos da NFE.
* (TODO) Não possui geração do código de barras.
* (TODO) Não possui quebra do número de folhas de acordo com a quantidade de itens.
* (TODO) Não possui a representação em formato paisagem.

### Arquitetura

* Usa [template engine handlebars](https://github.com/wycats/handlebars.js) para gerar o html.

## Testes

```
npm run test
```

### Codificação

[standardjs](https://standardjs.com/rules.html)


## Contribuições

* Contribuições podem ser enviadas através de pull request.
* Lembre-se de adicionar o teste respectivo a sua implementação.
* [Autores](https://github.com/djalmaoliveira/djf-danfe/contributors)

## Versão

[Semantic Versioning](http://semver.org/)


## Licença

[MIT](https://github.com/djalmaoliveira/djf-danfe/blob/master/LICENSE)