https://github.com/gabrielkunst/loan-simulator-back

API de simulação de empréstimo feito com Fastify, testada com Vitest e documentada com Swagger
https://github.com/gabrielkunst/loan-simulator-back

fastify nodejs swagger vitest

Last synced: 6 days ago
JSON representation

API de simulação de empréstimo feito com Fastify, testada com Vitest e documentada com Swagger

• Host: GitHub
• URL: https://github.com/gabrielkunst/loan-simulator-back
• Owner: gabrielkunst
• Created: 2024-08-04T03:37:42.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-08-05T02:08:29.000Z (about 2 months ago)
• Last Synced: 2024-09-19T04:08:35.483Z (14 days ago)
• Topics: fastify, nodejs, swagger, vitest
• Language: TypeScript
• Homepage:
• Size: 67.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Simulador de Empréstimo API

Este projeto é a API backend para o Simulador de Empréstimo. Foi criado com Fastify, testado com Vitest, e documentado com Swagger. Utiliza PostgreSQL para o banco de dados, configurado e executado via Docker.

## Funcionalidades

- **API de Empréstimos:** Simule e crie empréstimos.

- **Documentação:** A documentação da API está disponível via Swagger.

- **Banco de Dados:** Utiliza PostgreSQL para armazenamento de dados.

## Estrutura do Projeto

- `src/`: Diretório principal do código fonte.

  - `types/`: Tipos e interfaces TypeScript.

  - `http/`: Configurações do servidor HTTP.

    - `routes/`: Rotas da API.

  - `repositories/`: Acesso ao banco de dados.

  - `use-cases/`: Regras de negócio da aplicação.

  - `utils/`: Utilitários e funções auxiliares.

- `tests/`: Testes automatizados usando Supertest.

## Swagger

A documentação da API está disponível em `/docs`.

## Como Baixar e Configurar

1. **Clone o Repositório:**

Clone o repositório do backend:

```bash

  git clone https://github.com/gabrielkunst/loan-simulator-back.git

```

2. **Instale as Dependências:**

Navegue para o diretório do projeto e instale as dependências:

```bash

  cd loan-simulator-back

  npm install

```

3. **Configure o Banco de Dados:**

O banco de dados PostgreSQL é executado via Docker. Certifique-se de ter o Docker e o Docker Compose instalados. Execute o Docker Compose para iniciar o banco de dados:

```bash

  docker-compose up -d

```

4. **Configure as Variáveis de Ambiente:**

Crie um arquivo `.env` na raiz do projeto seguindo o modelo do arquivo `.env.example`. Preencha as variáveis de ambiente com as informações do banco de dados.

5. **Execute as Migrações:**

Execute as migrações para criar as tabelas no banco de dados:

```bash

  npx prisma generate

  npx prisma migrate dev

```

6. **Inicie o Servidor:**

Inicie o servidor:

```bash

  npm run dev

```