API de Gestão Financeira

Essa é uma API RESTful de um sistema de gestão financeira. A API foi desenvolvida em Node.js com o framework Nest.js e um banco de dados relacional.

Documentação da API

Caso queira ver a documentação da API, acesse o link abaixo:

• Documentação da API

Obs: O carregamento da página pode demorar um pouco, pois está em servidor gratuito, então a instância é desligada após alguns minutos de inatividade.

Executando a API Localmente

Pré-requisitos

• Docker
• Docker Compose

Passos para execução

1. Clone o repositório:

   git clone <URL_DO_REPOSITORIO>
   cd <NOME_DO_REPOSITORIO>

2. Copie o arquivo .env.example para .env e configure as variáveis de ambiente:

   cp .env.example .env

   Preencha a variável POSTGRES_HOST com o valor db e as outras variáveis de acordo com o seu ambiente.

3. Execute o comando abaixo para criar a imagem da aplicação e do banco de dados:

   docker compose -f docker-compose.dev.yaml up --build

4. Acesse a documentação da API em http://localhost:3000/api

Observações

• Certifique-se de que as variáveis de ambiente estão corretamente configuradas no arquivo .env.

• O banco de dados será iniciado automaticamente junto com a aplicação.

• Para parar os containers, utilize o comando:

  docker compose -f docker-compose.dev.yaml down

Contribuição

Sinta-se à vontade para contribuir com este projeto. Para isso, siga os passos abaixo:

1. Faça um fork do projeto
2. Crie uma nova branch (git checkout -b feature/nova-feature)
3. Faça commit das suas alterações (git commit -am 'Adiciona nova feature')
4. Faça push para a branch (git push origin feature/nova-feature)
5. Abra um Pull Request

Licença

Este projeto está licenciado sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.