Esta é uma aplicação em NodeJS que calcula a revisão do FGTS utilizando o índice INPC. A aplicação é capaz de importar um extrato em PDF do FGTS da Caixa Econômica Federal e extrair os dados necessários para realizar o cálculo automaticamente.
Para instalar e configurar o projeto, siga os seguintes passos:
- Clone este repositório para a sua máquina local.
- Instale as dependências usando o comando
npm install
.
Para usar a aplicação, siga os seguintes passos:
- Execute o comando
npm dev
para iniciar a aplicação em um ambiente local de desenvolvimento ounpm build
seguido denpm start
para iniciar a aplicação em um ambiente de produção. - A aplicação irá iniciar uma API REST que possui um endpoint POST para realizar o upload do extrato. O endpoint é:
http://localhost/api/extract
- Envie uma solicitação POST para o endpoint
http://localhost/api/extract
com o arquivo PDF do extrato do FGTS como stream. - Após enviar a solicitação POST para o endpoint
http://localhost/api/extract
, o resultado será retornado na resposta da requisição.
Contribuições são bem-vindas e encorajadas! Para contribuir com este projeto, siga os seguintes passos:
- Fork este repositório.
- Crie uma nova branch para a sua contribuição.
- Faça as mudanças desejadas e adicione testes, se necessário.
- Envie um pull request para a branch principal.
Este projeto foi desenvolvido por Paulo Henrique Sousa da Silva.
Este projeto está licenciado sob a Licença MIT.
Para entrar em contato, envie um e-mail para pauloofmeta@gmail.com.