Code Monkey home page Code Monkey logo

loan-simulator-back's Introduction

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:

  git clone https://github.com/gabrielkunst/loan-simulator-back.git
  1. Instale as Dependências:

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

  cd loan-simulator-back
  npm install
  1. 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:

  docker-compose up -d
  1. 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.

  1. Execute as Migrações:

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

  npx prisma generate
  npx prisma migrate dev
  1. Inicie o Servidor:

Inicie o servidor:

  npm run dev

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.