Projeto pessoal de gestão financeira. Self-hosted, manual e open source.

⚠️ Não há versão online hospedada. Você precisa clonar o repositório e rodar localmente ou no seu próprio servidor.

---

---

📖 Índice

• Sobre o Projeto
• Instalação via Script
  • Preparar o servidor (Ubuntu 24.04)
• Início Rápido (manual)
• Scripts Disponíveis
• Docker
• Backup
• Storage S3 Compatível
• Variáveis de Ambiente
• Arquitetura
• Contribuindo
• Apoie o Projeto
• Licença

---

🎯 Sobre o Projeto

OpenMonetis é um projeto pessoal de gestão financeira que criei para organizar minhas próprias finanças. Cansei de usar planilhas desorganizadas e aplicativos que não fazem exatamente o que preciso, então decidi construir algo do jeito que funciona pra mim.

A ideia é simples: ter um lugar onde consigo ver todas as minhas contas, cartões, gastos e receitas de forma clara. Se isso for útil pra você também, fique à vontade para usar e contribuir.

💡 Licença Não-Comercial: Este projeto é gratuito para uso pessoal, mas não pode ser usado comercialmente. Veja mais detalhes na seção Licença.

⚠️ Avisos importantes

1. Não há versão hospedada online — Este projeto é self-hosted. Você precisa rodar no seu próprio computador ou servidor.

2. Não há Open Finance — Não há conexão automática com bancos. Você pode registrar transações manualmente, usar o app companion para capturar notificações bancárias ou importar extratos nos formatos OFX e XLS/XLSX.

3. Requer disciplina — O OpenMonetis funciona melhor para quem tem disciplina de registrar os gastos regularmente, quer controle total sobre seus dados e gosta de entender exatamente onde o dinheiro está indo.

Funcionalidades

💰 Contas e transações — Contas bancárias, cartões, dinheiro. Receitas, despesas e transferências. Categorização, extratos detalhados e importação de extratos OFX e XLS/XLSX com detecção automática de categoria.

📊 Dashboard e relatórios — Widgets interativos de métricas, gráficos de evolução, comparativos por categoria, tendências, uso de cartões, top estabelecimentos. Exportação em PDF e Excel.

💳 Faturas de cartão — Acompanhe faturas por período, controle limites e vencimentos.

🎯 Orçamentos — Defina limites por categoria e acompanhe o progresso.

💸 Parcelamentos avançados — Séries de parcelas, antecipação com cálculo de desconto, análise consolidada.

🤖 Insights com IA — Análises geradas por Claude, GPT, Gemini ou OpenRouter. Insights personalizados e histórico salvo.

👥 Gestão colaborativa — Pagadores com permissões (admin/viewer), notificações automáticas por e-mail, códigos de compartilhamento.

📝 Anotações e tarefas — Notas de texto, listas com checkboxes, sistema de arquivamento.

📅 Calendário financeiro — Visualize todos os lançamentos em um calendário mensal.

📲 OpenMonetis Companion — App Android que captura notificações bancárias (Nubank, Itaú, Bradesco, Inter, C6 e outros) e envia automaticamente como pré-lançamentos para revisão — sem digitar nada. Repositório.

⚙️ Personalização — Tema dark/light e modo privacidade.

Stack técnica

• Next.js (App Router, Turbopack) + React + TypeScript
• PostgreSQL + Drizzle ORM
• Better Auth (email/senha, OAuth, Passkeys/WebAuthn)
• shadcn/ui (Radix UI) + Tailwind CSS
• Docker (multi-stage build)
• Biome (linting + formatting)
• Vercel AI SDK (Claude, GPT, Gemini, OpenRouter)

---

⚡ Instalação via Script

A forma mais rápida de instalar. O script verifica dependências, configura o .env interativamente e sobe o banco automaticamente.

🖥️ Preparar o servidor (Ubuntu 24.04)

Se você está num servidor Ubuntu limpo (VPS, Oracle Cloud, DigitalOcean...) sem Node.js, Docker ou pnpm instalados, use o script de preparação antes de continuar.

⚠️ Testado apenas em Ubuntu Server 24.04 LTS. Em outras distribuições ou versões é necessário testar ou ajustar o script.

curl -fsSL https://raw.githubusercontent.com/felipegcoutinho/openmonetis/main/scripts/install-deps.sh -o install-deps.sh
sudo sh install-deps.sh

O script instala (e pula o que já estiver presente):

Ferramenta	Como instala
git, curl, ca-certificates	apt
Docker Engine + Docker Compose	Repositório oficial do Docker
Homebrew	Script oficial (como usuário não-root)
Node.js 22	Via Homebrew
pnpm	Via corepack

Após a conclusão, adiciona o usuário atual ao grupo docker — faça logout/login para ativar. Em seguida, prossiga com o setup.mjs abaixo.

---

Pré-requisito: Node.js 22+

# Mac / Linux / WSL
curl -fsSL https://raw.githubusercontent.com/felipegcoutinho/openmonetis/main/setup.mjs -o setup.mjs && node setup.mjs

# Windows (PowerShell)
curl -o setup.mjs https://raw.githubusercontent.com/felipegcoutinho/openmonetis/main/setup.mjs ; node setup.mjs

O script irá:

• Verificar Node, pnpm, Git e Docker
• Perguntar se quer banco local (Docker) ou remoto (Supabase, Neon, etc.)
• Gerar o BETTER_AUTH_SECRET automaticamente
• Configurar opcionais: Google OAuth, e-mail, IA, domínio público
• Clonar o repositório, instalar dependências e aplicar o schema

---

🚀 Início Rápido (manual)

Pré-requisitos

• Node.js 22+ e pnpm
• Docker e Docker Compose

Passo a Passo

1. Clone e instale

   git clone https://github.com/felipegcoutinho/openmonetis.git
   cd openmonetis
   pnpm install
   

2. Configure o .env

   cp .env.example .env
   

   Edite o .env com suas credenciais. O principal é o DATABASE_URL e o BETTER_AUTH_SECRET:

   # Banco local (Docker): use host "localhost"
   DATABASE_URL=postgresql://openmonetis:openmonetis_dev_password@localhost:5432/openmonetis_db
   
   # Banco remoto (Supabase, Neon, etc): use a URL completa do provider
   # DATABASE_URL=postgresql://user:password@host:5432/database?sslmode=require
   
   BETTER_AUTH_SECRET=seu-secret-aqui  # gere com: openssl rand -base64 32
   BETTER_AUTH_URL=http://localhost:3000
   

3. Suba o banco de dados (pule se estiver usando banco remoto)

   docker compose up db -d
   pnpm db:extensions
   

4. Execute as migrations e inicie

   pnpm db:push
   pnpm dev
   

5. Acesse http://localhost:3000

Docker completo (app + banco em containers): use pnpm docker:up:local ao invés dos passos 3-4.

---

📜 Scripts Disponíveis

Desenvolvimento

pnpm dev              # Dev server (Turbopack)
pnpm build            # Build de produção
pnpm start            # Servidor de produção
pnpm lint             # Biome check
pnpm lint:fix         # Biome auto-fix

Banco de Dados

pnpm db:generate      # Gerar migrations
pnpm db:migrate       # Executar migrations
pnpm db:push          # Push schema direto (dev)
pnpm db:extensions    # Habilitar extensões PostgreSQL (rodar uma vez)
pnpm db:studio        # Drizzle Studio (UI visual)

Utilitários

pnpm backup           # Backup completo do banco (ver seção Backup)

Docker

pnpm docker:up:local      # Sobe app + banco PostgreSQL juntos (imagem do Hub)
pnpm docker:up            # Sobe apenas o app com build local
pnpm docker:up:d          # Sobe apenas o app com build local em background
pnpm docker:up:db         # Sobe apenas o banco em background
pnpm docker:down          # Para e remove os containers
pnpm docker:down:volumes  # Para containers e remove volumes (⚠️ apaga dados!)
pnpm docker:logs          # Logs em tempo real (todos os containers)
pnpm docker:logs:app      # Logs do container da aplicação
pnpm docker:logs:db       # Logs do container do banco
pnpm docker:restart       # Reinicia todos os containers
pnpm docker:rebuild       # Rebuild completo forçando recriação

---

🐳 Docker

O Dockerfile usa multi-stage build (deps → builder → runner) com imagem final ~200MB rodando como usuário não-root.

Health checks configurados para ambos os serviços (PostgreSQL via pg_isready, app via GET /api/health).

Modos de uso

Modo 1 — App + banco local (recomendado para self-hosting)

Puxa a imagem pronta do Docker Hub e sobe app + banco juntos. Não precisa de Node.js instalado.

# 1. Baixar o docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/felipegcoutinho/openmonetis/main/docker-compose.yml -o docker-compose.yml

# 2. Criar o .env (copie o .env.example como referência)
# DATABASE_URL=postgresql://openmonetis:SUA_SENHA@db:5432/openmonetis_db
# POSTGRES_PASSWORD=SUA_SENHA
# BETTER_AUTH_SECRET=string-longa-aleatoria
# BETTER_AUTH_URL=http://localhost:3000

# 3. Subir
docker compose --profile local up
# ou, se tiver o projeto clonado:
pnpm docker:up:local

Modo 2 — App com banco remoto

Use quando o banco está em um provider externo (Supabase, Neon, Railway...).

# DATABASE_URL deve apontar para o banco remoto no .env
docker compose up

Modo 3 — Build local (desenvolvimento)

Builda a imagem localmente a partir do código-fonte.

pnpm docker:up        # app apenas (banco separado)
pnpm docker:up:db     # sobe o banco em background

Comandos úteis

docker compose exec app sh                                      # Shell da aplicação
docker compose exec db psql -U openmonetis -d openmonetis_db    # Shell do banco
docker compose ps                                                # Status
docker compose exec db pg_dump -U openmonetis openmonetis_db > backup.sql  # Backup
docker compose exec -T db psql -U openmonetis -d openmonetis_db < backup.sql  # Restore

Customizando Portas

APP_PORT=3001   # Padrão: 3000
DB_PORT=5433    # Padrão: 5432

---

💾 Backup

O backup é uma rotina de infraestrutura — não é uma tela no app. Ele opera diretamente sobre o banco PostgreSQL e é executado via linha de comando.

pnpm backup

O que é salvo

Cada execução gera 3 arquivos em backup/:

Arquivo	Conteúdo	Uso
openmonetis_YYYY-MM-DD_HH-MM.dump	Dump custom do PostgreSQL (binário)	Restore completo via pg_restore
openmonetis_YYYY-MM-DD_HH-MM.sql.gz	Dump SQL completo compactado	Inspeção manual, portabilidade
openmonetis_YYYY-MM-DD_HH-MM.data.sql.gz	Apenas os dados da schema public	Migração parcial, seed de outro ambiente

Modos de conexão

Configure DB_MODE no topo de scripts/backup.sh:

Modo	Quando usar	Fonte de dados
remote (padrão)	Banco em Supabase, Neon, Railway, etc.	DATABASE_URL do .env
docker	Banco no container local	Container openmonetis_postgres

Upload para Google Drive (opcional)

Se o rclone estiver instalado e configurado com um remote chamado gdrive, os arquivos são enviados automaticamente para gdrive:BACKUP OPENMONETIS. Sem o rclone, o backup funciona normalmente e fica apenas local.

Retenção:

• Local: 7 dias
• Google Drive: 30 dias

Automatizar com cron

Para rodar o backup automaticamente todo dia às 3h:

crontab -e

0 3 * * * cd /caminho/para/openmonetis && pnpm backup >> /var/log/openmonetis-backup.log 2>&1

Restore

# A partir do .dump (recomendado — mais rápido)
pg_restore --clean --no-owner --no-privileges \
  -d "postgresql://user:senha@host:5432/openmonetis_db" \
  backup/openmonetis_YYYY-MM-DD_HH-MM.dump

# A partir do .sql.gz (banco local via Docker)
gunzip -c backup/openmonetis_YYYY-MM-DD_HH-MM.sql.gz | \
  docker compose exec -T db psql -U openmonetis -d openmonetis_db

---

☁️ Storage S3 Compatível

O suporte a anexos de lançamentos usa upload direto com URL pré-assinada. Essa configuração é opcional, mas passa a ser necessária se você quiser habilitar anexos no app.

Variáveis

S3_ENDPOINT=
S3_REGION=
S3_ACCESS_KEY_ID=
S3_SECRET_ACCESS_KEY=
S3_BUCKET=

Compatibilidade

• O código atual espera um provider com API compatível com S3 e suporte a PutObject, GetObject, HeadObject, DeleteObject e URLs pré-assinadas.
• A implementação usa endpoint customizado e forcePathStyle: true em src/shared/lib/storage/s3-client.ts.
• Em geral isso cobre MinIO, Cloudflare R2, Backblaze B2 S3-Compatible, DigitalOcean Spaces e AWS S3. Mas foi testado apenas no Supabase Storage.
• Se o seu provider exigir virtual-hosted-style em vez de path-style, você vai precisar ajustar essa configuração antes de usar anexos.
• Se as variáveis de S3 não forem configuradas, mantenha os anexos desabilitados no seu fluxo de uso.

---

🔐 Variáveis de Ambiente

Copie .env.example para .env e configure:

Obrigatórias

DATABASE_URL=postgresql://openmonetis:openmonetis_dev_password@localhost:5432/openmonetis_db
BETTER_AUTH_SECRET=seu-secret-aqui    # openssl rand -base64 32
BETTER_AUTH_URL=http://localhost:3000

Opcionais

# PostgreSQL (Docker local)
POSTGRES_USER=openmonetis
POSTGRES_PASSWORD=openmonetis_dev_password
POSTGRES_DB=openmonetis_db

# S3 Server (opcional, necessario para anexos)
S3_ENDPOINT=
S3_REGION=
S3_ACCESS_KEY_ID=
S3_SECRET_ACCESS_KEY=
S3_BUCKET=

# Multi-domínio (landing-only no domínio público)
# PUBLIC_DOMAIN=openmonetis.com

# OAuth
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

# Email (Resend)
RESEND_API_KEY=
RESEND_FROM_EMAIL=

# AI Providers
ANTHROPIC_API_KEY=
OPENAI_API_KEY=
GOOGLE_GENERATIVE_AI_API_KEY=
OPENROUTER_API_KEY=

---

🏗️ Arquitetura

O projeto segue arquitetura feature-first dentro de src/:

openmonetis/
├── src/
│   ├── app/                       # Next.js App Router (rotas finas)
│   │   ├── api/                   # API Routes (auth, health, inbox)
│   │   ├── (auth)/                # Login e cadastro
│   │   ├── (dashboard)/           # Rotas protegidas (transactions, cards, accounts, etc.)
│   │   └── (landing-page)/        # Página inicial pública
│   │
│   ├── features/                  # Código de domínio por feature
│   │   ├── dashboard/             # Widgets, queries e métricas
│   │   ├── transactions/          # Lançamentos, ações em lote, exportação
│   │   ├── cards/                 # Cartões de crédito
│   │   ├── invoices/              # Faturas
│   │   ├── accounts/              # Contas bancárias
│   │   ├── categories/            # Categorias e histórico
│   │   ├── budgets/               # Orçamentos
│   │   ├── payers/                # Pagadores e compartilhamento
│   │   ├── inbox/                 # Pré-lançamentos do Companion
│   │   ├── insights/              # Análises com IA
│   │   ├── reports/               # Relatórios e exportações
│   │   ├── notes/                 # Anotações
│   │   ├── calendar/              # Calendário financeiro
│   │   ├── settings/              # Ajustes do usuário
│   │   ├── landing/               # Landing page
│   │   └── auth/                  # Formulários de autenticação
│   │
│   ├── shared/                    # Código reutilizado entre features
│   │   ├── components/            # UI compartilhada (shadcn/ui, navigation, skeletons...)
│   │   ├── hooks/                 # React hooks globais
│   │   ├── lib/                   # Helpers de domínio (auth, db, payers, schemas, email...)
│   │   └── utils/                 # Utilitários (currency, date, period, math, string...)
│   │
│   └── db/
│       └── schema.ts              # Drizzle schema (fonte única de verdade)
│
├── public/                        # Assets estáticos (imagens, logos, fontes)
├── drizzle/                       # Migrations geradas
├── scripts/                       # Scripts utilitários (migrations, dev)
├── Dockerfile                     # Multi-stage build (~200MB, non-root)
├── docker-compose.yml             # Orquestração app + PostgreSQL
└── proxy.ts                       # Middleware (auth + multi-domínio)

---

🤝 Contribuindo

1. Fork o projeto
2. Clone seu fork: git clone https://github.com/seu-usuario/openmonetis.git
3. Crie uma branch: git checkout -b feature/minha-feature
4. Commit: git commit -m 'feat: adiciona minha feature'
5. Push: git push origin feature/minha-feature
6. Abra um Pull Request

Antes de começar, leia o CLAUDE.md — ele documenta a arquitetura, convenções de nomenclatura, regras de queries e o checklist para novas features. Use TypeScript, commits semânticos e mantenha o CHANGELOG.md atualizado.

---

💖 Apoie o Projeto

Se o OpenMonetis está sendo útil, considere se tornar um sponsor!

Outras formas de contribuir: ⭐ estrela no repo, reportar bugs, melhorar docs, submeter PRs.

---

📄 Licença

Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0).

• ✅ Uso pessoal, modificação, distribuição e fork
• ❌ Uso comercial, remoção de créditos, mudança de licença
• 📋 Crédito ao autor, indicar modificações, mesma licença

Para o texto legal completo, consulte o arquivo LICENSE ou visite creativecommons.org.

---

🙏 Agradecimentos

Next.js · Better Auth · Drizzle ORM · shadcn/ui · Biome · Vercel

---

Desenvolvido por: Felipe Coutinho — @felipegcoutinho

⭐ Se este projeto foi útil pra você:

Dê uma estrela · Apoie como sponsor · Compartilhe