Technologias • Rodando localmente • Rotas da API
uma API REST para te ajudar na validação dos seus boletos e contas a pagar.
- Node
- Typescript
- Express
- Jest
- Docker
Clone o projeto
git clone https://github.com/abnerpersio/billing-helper.git
Instale as dependências
yarn install
Duplique o arquivo .env.example
e altere as variáveis de ambiente
Para rodar os testes:
yarn test
Para rodar a API em desenvolvimento:
yarn dev
Faça o build do projeto:
yarn build
Inicie o servidor:
yarn start
Rode o projeto:
docker-compose up
Lembrando que também é válido usar o npm
, não é obrigatório usar o yarn
:)
Rotas disponíveis:
route | request | response |
---|---|---|
GET /health | - | { "message": "ok" } |
GET /boleto/:digitableLine | - | { "barCode "barCode", "amount": "00.00", "expirationDate": "YYYY-MM-DD" } |