Balanço Pessoal

Rest API de balanço patrimonial simplificado e pessoal.

Este é um projeto desenvolvido para avaliação na fase 2 do processo seletivo do Projeto TED 9910/2020.

Primeiros Passos

1. Instale as dependências do projeto: Node.Js e Yarn
2. Clone o repositório e acesse o diretório balanco-pessoal.
3. Execute no terminal:
   1. yarn *Este comando irá instalar todas as dependências do projeto.
   2. yarn dev *Este comando irá executar o servidor

Obs: As requisições que utilizei para testar a API no Insomnia pode ser encontrada aqui. Basta importar elas.

Rotas da API

Rota	Descrição	Corpo da Requisição (JSON)
/auth/login	Rota utliziada pra autenticar o usuário. Recebe e-mail e senha no corpo da requisição.	{"email": "[email protected]", "password": "exemplo"}
/auth/signup	Realiza o cadastro de um novo usuário. Recebe e-mail e senha no corpo da requisição.	{"email": "[email protected]", "password": "exemplo"}
/auth/logout	Efetua o logout do usuário que está autenticado no momento.
/wallet	Exibe todas as transações de gasto e de renda do usuário autenticado. É necessário está autenticado para fazer requisições nesta rota.
/wallet/deposit	Registra uma nova renda na wallet do usuário autenticado. Recebe a descrição e o valor da renda no corpo da requisição. É necessário está autenticado para fazer requisições nesta rota.	{"descrição": "exemplo de renda", "valor": 150}
/wallet/withdraw	Registra um novo gasto na wallet do usuário autenticado. Recebe a descrição e o valor do gasto no corpo da requisição. É necessário está autenticado para fazer requisições nesta rota.	{"descrição": "exemplo de gasto", "valor": 150}

Tabelas do banco de dados

Usuários

Tabela que armazena os usuários cadastrados.

Atributo	Descrição
uid	Chave primária, sendo um número único que identifica cada usuário cadastrado no sistema.
name	Nome do Usuário
email	E-mail do Usuário, é utilizado para autentica-lo.
password	Senha o Usuário, é utilizado para autentica-lo.

Transações

Tabela que armazena as transações, seja uma renda ou um gasto.

Atributo	Descrição
id	Chave primária, sendo um número único que identifica cada transação cadastrada no sistema.
description	Descrição da transação.
valor	Valor na unidade monetária desejada.
owner	Chave estrangeira vinculada ao uid da tabela de usuários, sendo um numero único de usuário que o vicula a transação.
type	Número que identifica o tipo de transação, sendo 1 para gasto e 2 para renda.