API de Controle Financeiro - Dindin

Este projeto foi desenvolvido como parte do Módulo 3 da Cubos Academy, consiste em uma API denominada "Dindin". Com o objetivo de proporcionar uma solução eficiente para a gestão financeira pessoal, a API permite operações como cadastro de usuário, login, edição de perfil, gerenciamento de categorias e transações, e obtenção de extrato financeiro.

👩‍🔧 Linguagens e Ferramentas

🖌️ Layout

• Insomnia

• Beekeeper

🚩 Contribua com o projeto

• Realize o Fork
• Faça as modificações necessárias
• Realize a Pull Request (PR)

🗃️ Fucionalidades do Projeto

• Gerenciamento de Usuários

  • Cadastrar Usuário
  • Fazer Login
  • Detalhar Perfil do Usuário Logado
  • Editar Perfil do Usuário Logado

• Gerenciamento de Categorias

  • Listar categorias

• Gerenciamento de Transações

  • Listar transações
  • Detalhar transação
  • Cadastrar transação
  • Editar transação
  • Remover transação

• Relatórios e Consultas

  • Obter extrato de transações
  • Filtrar transações por categoria

💻 Rodando o Projeto

# 1. Clone o projeto

git clone https://github.com/christianebs/js-api-dindin/

# 2. Instale as dependências

npm install

# 3. Execute o servidor com nodemon para reinicialização automática

npm run dev

Observações:

• As dependências estão definidas no arquivo package.json. Ao executar npm install, todas elas serão instaladas
• O arquivo package.json já contém a configuração necessária na seção de scripts para utilizar o nodemon:

"scripts": {
    "dev": "nodemon ./src/index.js"
},

Essa configuração permite iniciar o servidor em modo de desenvolvimento usando o nodemon.

• Não é necessário inicializar um novo projeto Node.js com npm init -y, pois ao clonar o repositório, você já terá um package.json configurado.
• Para encerrar todos os serviços, utilize o atalho padrão do terminal pressionando CTRL+C. Esse comando interrompe a execução dos processos, encerrando o servidor e liberando o terminal.

🔄 Endpoints

• POST /usuario - Cadastrar um novo usuário no sistema
• POST /login - Realizar o login de um usuário cadastrado
• GET /usuario - Obter informações do perfil do usuário autenticado
• PUT /usuario - Atualizar informações do perfil do usuário autenticado
• GET /categoria - Listar todas as categorias cadastradas
• GET /transacao - Obter uma lista de todas as transações do usuário logado
• GET /transacao/:id - Consultar detalhes de uma transação específica do usuário logado
• POST /transacao - Adicionar uma nova transação associada ao usuário logado
• PUT /transacao/:id - Atualizar informações de uma transação do usuário logado
• DELETE /transacao/:id - Excluir uma transação do usuário logado
• GET /transacao/extrato - Gerar um extrato com a soma de transações de entrada e saída do usuário logado
• GET /transacao?filtro[]=roupas&filtro[]=salários - Consultar transações do usuário logado com base em categorias específicas

👩‍💻 Desenvolvedoras

Christiane Barbosa	Marcela Linhares