The Budget App - Back-End

O que é necessário para testar essa aplicação?

• Ter o Node.js instalado na versão 21.4.0 ou acima;
• Ter o gerenciador de pacotes Yarn instalado;
• Algum Rest Client: Insomnia, Postman, cURL, Thunder;

Tecnologias utilizadas

• NestJS
• TypeScript
• Express
• Prisma
• PostgreSQL
• JWT
• Swagger

Rotas pelo Postman

Usuários

Itens

Variáveis de Ambiente

Para rodar esse projeto, você vai precisar adicionar as seguintes variáveis de ambiente no seu .env

DB

DATABASE_URL

JWT

JWT_SECRET

Rodando localmente

Clone o projeto

  git clone https://github.com/egMarshall/the_budget_back

Entre no diretório do projeto

  cd the_budget_back

Instale as dependências

  yarn

Inicie o banco de dados

 npx prisma generate

npx prisma migrate deploy

Inicie o servidor

  yarn start:dev

Rodando no Docker

  docker-compose up --build

Funcionalidades

Usuários:

• Cadastrar Usuário;
• Login de Usuário;
• Validar Sessão do Usuário;
• Atualizar dados de Usuário;
• Deletar Usuário;
• Buscar Usuário por ID;
• Buscar todos os usuários.

Itens:

• Cadastrar Item (Receita ou Despesa) do Usuário;
• Atualizar Item por ID;
• Deletar Item por ID;
• Buscar Item por ID;
• Buscar todos os Items do usuário por ID do usuário.

Endpoints

Swagger Documentation

  GET /api-docs

Criar Usuário

  POST /users/signup

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do usuário
email	string	Obrigatório. e-mail do usuário
password	string	Obrigatório. Senha do usuário

Login do Usuário

  POST /users/login

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do usuário
password	string	Obrigatório. Senha do usuário

Validar Sessão do Usuário

  GET /users/login/session

Parâmetro	Tipo	Descrição
token	string	Obrigatório. Token do usuário

Atualizar dados do Usuário (apenas nome ou senha)

  PUT /users/

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do usuário
password	string	Obrigatório. Senha do usuário

Deletar Usuário

  DELETE /users

Buscar Usuário

  GET /users

Buscar todos os Usuários

  GET /users/all

Criar Item

  POST /budget-items

Parâmetro	Tipo	Descrição
user_id	string	Obrigatório. ID do Usuário
name	string	Obrigatório. Nome do Item
vale	Number	Obrigatório. Valor do item
type	string	Obrigatório. Tipo do item (Receita ou Despesa)
date	Date	Obrigatório. Data do Gasto ou Receita

Editar Item

  PUT /budget-items/:id

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do Item
vale	Number	Obrigatório. Valor do item
type	string	Obrigatório. Tipo do item (Receita ou Despesa)
date	Date	Obrigatório. Data do Gasto ou Receita

Deletar Item

  DELETE /budget-items/:id

Buscar Item

  GET /budget-items/:id

Buscar todos os Itens do Usuário

  GET /budget-items/all

• Exemplo de Requisição:

curl -X POST \
  http://localhost:3001/users/login \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{
	"email": "kukac@kukac.com",
    "password": "kukac123"
}'