Democratizando a gestão financeira pessoal através do Open Finance e da Inteligência Artificial.

Projeto homologado e apresentado na MOCITEC — Mostra de Ciências e Tecnologias do IFSul Campus Charqueadas.

---

Descrição

O ContaComigo é uma Prova de Conceito (PoC) de aplicação web voltada à democratização da gestão financeira pessoal no Brasil. Integra dados bancários via Open Finance (regulamentado pelo BACEN) com Inteligência Artificial generativa (Google Gemini) para oferecer orçamento semáforo inteligente, diagnósticos e educação financeira — sem exercer aconselhamento regulamentado por CVM/Bacen.

A aplicação foi submetida, homologada e apresentada na MOCITEC (Mostra de Ciências e Tecnologias do IFSul Campus Charqueadas). Para o texto completo do resumo submetido à mostra, acesse:

Resumo homologado (MOCITEC) — docs/RESUMO-MOCITEC.md

Principais funcionalidades (PoC em andamento)

• 🏦 Consolidação Open Finance — agregação de múltiplas instituições bancárias em um único dashboard (Pluggy Sandbox)
• 🚦 Orçamento Semáforo Inteligente — visualização Verde ≤70% / Amarelo 70–90% / Vermelho >90% com barras verticais animadas, limites editáveis inline e sugestões de ajuste por IA
• 📊 Histórico de 6 meses — análise de tendências, gasto médio, top 3 problemas recorrentes e mapa de status por categoria
• 🤖 Diagnóstico e Insights de IA (RAG) — painel rotativo de oportunidades, alertas e metas, com CTAs navegáveis para ações
• 💬 Chatbot Educativo — consultor financeiro IA com banner permanente de "não aconselhamento financeiro" + cards de status orçamentário e planos de compra simulados
• 📄 Exportar Relatórios — menu visual PDF / CSV por mês ou histórico completo
• 📱 Interface 100% responsiva — Bento Grid desktop + Bottom Dock + Sidebar desktop, layout adaptado a celulares
• 🔐 Autenticação local — Login / Cadastro com validação via Zod + React Hook Form, proteção de rotas privadas

---

Tecnologias Utilizadas

Frontend (aplicação web, implementada)

• React 19 + TypeScript 6 — tipagem estrita e React Compiler
• Vite 8 — build tool e servidor de desenvolvimento
• TailwindCSS 4 — @theme inline, tokens customizados (cores, sizes, durations), sem tailwind.config.js
• React Router 7 — nested routes, proteção de rotas privadas, hash scrolling
• Zod 4 + React Hook Form 7 — validação de formulários
• Lucide React + Font Awesome (ícones)
• @radix-ui/react-toast + toaster custom
• Tailwind Merge + class-variance-authority + clsx
• Lint: ESLint 9 + typescript-eslint + react-hooks + react-refresh

Backend (a ser implementado)

• NestJS — regras de negócio e API REST
• Pluggy API (Sandbox) — agregação de dados Open Finance
• Google Gemini API + LangChain.js — motor de IA, orquestração de contexto e prompts
• PostgreSQL — persistência
• Docker + docker-compose — ambiente reproduzível

---

Como Executar o Projeto

Atualmente apenas a camada frontend está materializada no repositório (mock puro, sem backend integrado). A arquitetura pretendida para o backend está em docs/backlog/EPICO-TECNICO.md.

Pré-requisitos

• Node.js ≥ 22 (recomendado última versão LTS)
• pnpm ≥ 9 (corepack enable instala o gerenciador)
• (Opcional, backend futuro) Docker 27 + docker compose v2
• (Opcional, backend futuro) PostgreSQL 16

1. Clone o repositório

git clone https://github.com/Raullize/conta-comigo.git
cd conta-comigo

2. Instale as dependências do frontend

cd frontend
pnpm install

3. Suba o ambiente de desenvolvimento (Vite)

pnpm dev

A aplicação ficará disponível em http://localhost:5173 (porta padrão Vite).

4. Valide código e faça o build de produção

# Lint (ESLint 9 + Tailwind suggestCanonicalClasses)
pnpm lint

# Type-check strict (tsc -b) + build Vite otimizado
pnpm build

# Preview do build de produção localmente
pnpm preview

5. Backend — variáveis de ambiente

O backend (NestJS) lê as variáveis de backend/.env. Copie o modelo backend/.env.example → backend/.env e preencha: JWT_SECRET (obrigatório), ENCRYPTION_KEY, GEMINI_API_KEY (IA educativa; sem ela o adaptador falso assume), e opcionais PLUGGY_CLIENT_ID / PLUGGY_CLIENT_SECRET e AI_DAILY_LIMIT. A credencial do Postgres local já vem no docker-compose.yml.

---

Documentação

Documento	Descrição
Workflow Agêntico	Guia operacional: como puxar, executar, validar e fechar uma história
Kanban Oficial	Fonte única da próxima demanda
Resumo homologado MOCITEC	Texto completo submetido, aprovado e apresentado na Mostra
Especificação SDD-001	Problema, personas, escopo, fluxos e decisões em aberto
Requisitos	Catálogos de RF, RN e RNF com identificador estável
Decisões de Arquitetura	ADRs: o porquê de cada escolha estrutural
Épico de Negócio	Visão, personas, jornadas e regras de negócio
Épico Técnico	Arquitetura, segurança, testes, CI/CD e operação
Entregas	Registro cronológico de cada história concluída

---

Contribuindo

Este é um projeto acadêmico do IFSul Campus Charqueadas, submetido à MOCITEC. Contribuições são bem-vindas através do processo padrão de Pull Request:

1. Fork o repositório

2. Crie uma branch feature:

   git checkout -b feature/minha-contribuicao

3. Faça suas alterações com commits semânticos (Conventional Commits): feat(...), fix(...), refactor(...), docs(...), style(...)

4. Garanta pnpm lint && pnpm build exit 0 dentro de frontend/

5. Envie a branch: git push origin feature/minha-contribuicao

6. Abra um Pull Request contra a branch develop descrevendo a mudança

Referência GitHub: como criar uma solicitação de pull.

---

Equipe

Alunos Autores

Raul Lize Teixeira Desenvolvedor Full Stack

Miguel L. S. Lewandowski Desenvolvedor Full Stack

Thiago R. Caputi Desenvolvedor Full Stack

Orientador

Prof. Me. Everton Oliveira Fernandes Orientação acadêmica · IFSul Campus Charqueadas

---

Licença

Este repositório não possui licença aberta. É um trabalho acadêmico desenvolvido no IFSul Campus Charqueadas e apresentado na MOCITEC.

Sem licença declarada, valem os direitos autorais padrão: o código pode ser lido e avaliado, mas não há permissão de uso, cópia, modificação ou redistribuição. Para qualquer uso além da avaliação acadêmica, fale com os autores.