Skip to content

Lectio-Project/Backend-DinDin

Repository files navigation

DinDin API

API de gerenciamento de despesas.

⚙️ Instalação e Configuração

Siga os seguintes passos:

  1. Abra o terminal e clone este repositório para sua máquina com o seguinte comando:
git clone https://github.com/Lectio-Project/Backend-DinDin.git
  1. Navegue até a pasta do projeto com o comando:
cd Backend-DinDin
  1. Abra o projeto no seu VsCode (Se não tiver instalado, instale-o aqui!):
code .
  1. Renomei o arquivo .env.example para .env ou crie um arquivo .env na raiz do projeto
  • Crie e/ou preencha no arquivo .env a variável de ambiente DATABASE_URL com o link para o seu banco de dados MongoDB
  • No arquivo .env crie e/ou preencha o JWT_SECRET_KEY com a sua chave JWT secreta
  1. Verifique se você possui o Node.js instalado em sua máquina, caso não instale-o, Baixe o Node.js aqui!

  2. Instale as dependências do projeto com o comando:

npm install
  1. Rode o seguinte comando para inicializar o servidor:
npm run start
  1. Para traduzir seu schema do Prisma ORM em código TypeScript que você pode usar em seu aplicativo para interagir com o banco de dados de forma segura e tipada rode o comando abaixo:
npx prisma generate
  1. Para aplicar todas as alterações necessárias para garantir que o esquema do banco de dados corresponda ao seu esquema definido no arquivo rode o seguinte comando:
npx prisma db push

📡 Rotas

Usuário

  • Cadastro de usuário:
routes.post("/sign-up");
  • Login de usuário:
routes.post("/login");
  • Atualização de usuário:
routes.put("/user/:id");

🆕 Funcionalidades

  • Usuários:
  1. Cadastrar usuário
  2. Login de usuário
  3. Atualização de usuário
  4. Autenticação e Autorização

🔧 Tecnologias

  • Nest
  • Express
  • TypeScript
  • Zod
  • Prisma ORM
  • MongoDB

🚀 Deploy

  • Link da API em produção:
Em Breve

© MIT License 2024, feito com ❤️ por Alisson Romão, Vanessa Ribeiro e Rochel Rodrigues.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published