Sistema Financeiro Fluxos | Segunda Versão 💵

1. Introdução

Este projeto se trata de um sistema financeiro de fluxo de caixa, que permite a gestão financeira de empresas de pequeno, médio porte e usuários comuns. Com ele, é possível realizar o controle de receitas, despesas, contas a pagar e a receber, além de gerar gráficos para análise financeira.

2. Tecnologias Utilizadas 📲

O projeto foi desenvolvido utilizando as seguintes tecnologias:

Frontend 📲

Backend 🛠️

Outros

Espero que isso ajude! Se você precisar de mais shields, fique à vontade para pedir.

3. Como Instalar 👨🏽‍💻

Backend

Para instalar o projeto, siga os seguintes passos:

1. Clone este repositório
2. Instale as dependências utilizando o comando npm install ou yarn
3. Crie um arquivo .env na raiz do projeto, com as seguintes variáveis:

DATABASE_URL=postgres://usuario:senha@endereco-do-banco:5432/nome-do-banco
JWT_SECRET=segredo

Substitua usuario, senha, endereco-do-banco e nome-do-banco pelos valores corretos de acordo com a configuração do seu banco de dados. 4. Execute as migrations do banco de dados com o comando npx prisma migrate dev ou yarn prisma migrate dev 5. Inicie o servidor com o comando npm run dev ou yarn dev 6. Acesse o sistema em http://localhost:3001

Atenção, a aplicação ainda pode conter alguns bugs, portanto, fiquem alerta.

Segue uma coleção incompleta no Insomnia.

backend/docs/collection.json

😁 Estamos trabalhando na documentação externa.

Frontend

1. Entre na pasta /frontend-vite
2. Instale as dependências utilizando o comando npm install ou yarn
3. Crie um arquivo .env na raiz do projeto, com as seguintes variáveis:

    # PRODUCAO 
    VITE_ENDPOINT=http://192.168.100.7:3001/api/v1

4. Execute o npm run dev para rodar a aplicação em ambiente de desenvolvimento e npm run build para gerar o build da aplicação;

Observação:

Se necessário, temos duas imagens Docker disponíveis para o projeto. Você pode encontrar a imagem do Backend aqui e a imagem do Frontend aqui.

4. Como Usar 😐

Principais Funcionalidades:

Claro, aqui estão as descrições corrigidas e melhoradas para cada item da lista:

1. Cadastro de Usuário: Trata-se de uma aplicação multilocatário simples que suporta vários usuários, cada um com seu próprio fluxo de caixa e funcionalidades. Os usuários têm a liberdade de personalizar os métodos de classificação dos itens de fluxo de caixa.

2. Dashboard: O painel exibe os dados do fluxo de caixa, classificados de acordo com a classificação do elemento.

3. Agenda: A agenda é um calendário que exibe as datas em que os itens do fluxo de caixa foram inseridos.

4. Fluxo de Caixa: Esta é a principal funcionalidade da aplicação, responsável pela manipulação dos dados financeiros.

5. Tipo de Despesas: Esta funcionalidade, compartilhada por todos os usuários, permite o controle do tipo de despesa, seja PIX, boleto, TED, DOC, Crédito ou Débito.

6. Locais: Nesta seção, os usuários podem cadastrar as instituições financeiras, como bancos e corretoras de valores.

7. Programação: Esta funcionalidade permite aos usuários cadastrar itens de rotina que serão inseridos no fluxo de caixa todos os meses.

8. Elementos: Esta funcionalidade permite aos usuários personalizar os métodos de classificação dos itens de fluxo de caixa. É aqui que os usuários podem definir e gerenciar os elementos que são usados para classificar as transações no fluxo de caixa.

Lista de funcionalidades

Aqui está a lista de funcionalidades do sistema, reescrita para uma melhor compreensão:

1. Cálculo do Saldo Atual: O sistema é capaz de calcular o saldo atual, somando todas as entradas e saídas.
2. Despesa Mensal por Usuário: O sistema pode somar todas as despesas de um usuário específico em um mês.
3. Receita Mensal por Usuário: Da mesma forma, o sistema pode calcular a receita total de um usuário em um mês.
4. Despesas por Classificação: O sistema pode somar todas as despesas de uma determinada classificação em um intervalo de datas.
5. Receitas por Classificação: Similarmente, o sistema pode somar todas as receitas de uma determinada classificação.
6. Despesas dos Últimos 12 Meses: O sistema pode recuperar todas as despesas dos últimos 12 meses.
7. Receitas dos Últimos 12 Meses: Da mesma forma, o sistema pode recuperar todas as receitas dos últimos 12 meses.
8. Limite de Gastos por Item: O sistema permite estabelecer um limite de gastos para cada item.
9. Adição Programada: O sistema pode criar itens de fluxo de caixa rotineiros.

Espero que isso ajude a entender melhor as funcionalidades do sistema! Se você tiver mais perguntas, fique à vontade para perguntar.

Para utilizar o sistema, siga os seguintes passos:

1. Acesse o sistema em http://localhost:5173
2. Faça login com um usuário existente ou cadastre um novo usuário
3. Na tela de Dashboard, é possível visualizar um resumo das informações financeiras
4. Nas demais telas, é possível realizar o cadastro, edição e exclusão das informações financeiras, além de gerar relatórios e gráficos de análise financeira.

5. Agradecimentos

Gostaríamos de agradecer a todos os contribuidores que ajudaram no desenvolvimento deste projeto.

6. Autor do Projeto

_{Joao Guilherme} 🚀

Feito com 🤭 por Joao Guilherme 👋🏽 Entre em contato links abaixo!

7 - Licença