Skip to content

unb-mds/2024-2-SuaFinanca

Repository files navigation

Sua Finança

Sistema de controle financeiro pessoal

O Sua Finança é um sistema desenvolvido para facilitar o gerenciamento financeiro pessoal, proporcionando uma visão consolidada de receitas, despesas e saldo disponível. Com uma abordagem intuitiva e prática, a solução ajuda a simplificar o controle dos gastos diários e contribui para a prevenção de dívidas indesejadas.

Indice

  1. Motivação
  2. Funcionalidades
  3. Tecnologias Utilizadas
  4. Como Usar
  5. Contribuição
  6. Licença
  7. Desenvolvedores

1. Motivação

Muitas pessoas enfrentam dificuldades no gerenciamento de suas finanças pessoais, especialmente por:

  • Falta de controle sobre os gastos diários;
  • Dificuldade em monitorar múltiplas fontes de receita e despesas;
  • Ausência de uma visão consolidada do saldo disponível.

Esses fatores podem levar à perda de controle financeiro, dificultando a identificação de padrões negativos e resultando, muitas vezes, em acúmulo de dívidas. Este sistema foi desenvolvido para enfrentar esses desafios, promovendo uma abordagem prática e intuitiva para o gerenciamento financeiro.

2. Funcionalidades

  • Registro de receitas e despesas;
  • Categorização de gastos e fontes de renda;
  • Cálculo automático do saldo disponível;
  • Gráficos e relatórios financeiros;
  • Exportação de dados para análise externa;

3. Tecnologias Utilizadas

  • Back-end: [TypeScript, Tsx, Vitest, Jest e Supertest, Cypress, Express, CORS, Prisma ORM, Dotenv, JSON Web Token (JWT), Winston, Bcrypt]
  • Front-end:[next.js, JavaScript, css, html, Vercel, Chart.js, Axios, Formik]

4. Como Usar

Pré-requisitos

  • node v22.8.0.
  • npx 10.8.2

Passos para Instalação

  1. Clone o repositório:
 git clone https://github.com/unb-mds/2024-2-SuaFinanca.git
  1. Instale as dependências:
npm install
  1. Inicie o servidor:
npm start
  1. Acesse a aplicação em http://localhost:3000.

5. Contribuição

Contribuições são bem-vindas! Se você tiver sugestões de novas funcionalidades, correções ou melhorias, sinta-se à vontade para abrir uma issue ou um pull request.

5.1 Etapas para contribuir

  1. Fork este repositório.
  2. Crie uma nova branch para sua funcionalidade/correção.
git checkout -b minha-feature
  1. Faça as alterações e commit:
git commit -m "Veja o padrão de commit"
  1. Envie sua branch para o repositório remoto:
git push origin minha-feature
  1. Abra um pull request.

6. Licença

Este projeto está sob a licença MIT. Consulte o arquivo LICENSE para mais detalhes.

7. Desenvolvedores