README

PT-BR

⚠️ Esse projeto é um trabalho em andamento ⚠️

Client para a API da FocusNFE. Este client é feito para abstrair algumas das principais funcionalidades da API dentro do ecossistema PHP.

Apesar de utilizar alguns pacotes do Symfony, este projeto pode ser usado em qualquer aplicação PHP, independente de qualquer framework.

Funcionalidades suportadas:

NFSe

• Geração/autorização
• Cancelamento
• Consulta
• Envio por email (através da API)

TO DO:

• NFe
• NFCe

Exemplos das funcionalidades suportadas podem ser encontrados em examples/

Dependências

• PHP >= 8.2

Testes e controle de qualidade

Além de testes unitários, este projeto utiliza o PHPStan e o PHPMetrics para controle de qualidade.

Para executar os testes: composer test

Para executar os testes e gerar um report de coverage: composer test-with-coverage (resultados serão exportados em HTML dentro de tests/coverage/)

Para executar o phpstan: composer phpstan

Para executar o phpmetrics: composer phpmetrics (resultados serão exportados em HTML dentro de phpmetrics/)

É possível também visualizar o status atual de coverage e phpmetrics dentro deste repositório.

EN

⚠️ This project is a work in progress ⚠️

This is a client for FocusNFE's API. This client is made to abstract some of the API features inside PHP's ecosystem.

This project uses some Symfony packages, but it can be used in any PHP application in a framework-agnostic way.

Supported features:

NFSe

• Authorization
• Cancel
• Retrieving
• Email sending (through the API)

TO DO:

• NFe
• NFCe

You can find examples of the supported features in examples/

Dependencies

• PHP >= 8.2

Testing and quality control

In addition to unit tests, we use PHPStan and PHPMetrics to ensure quality control in this project.

To run tests: composer test

To run tests and get a coverage report: composer test-with-coverage (results will be written in HTML inside tests/coverage/)

To run phpstan: composer phpstan

To run phpmetrics: composer phpmetrics (results will be written in HTML inside phpmetrics/)