marco
54cccdd095
- Removido README.md padrão do Laravel (backend) - Removidos scripts de deploy (não mais necessários) - Atualizado copilot-instructions.md para novo fluxo - Adicionada documentação de auditoria do servidor - Sincronizado código de produção com repositório Novo workflow: - Trabalhamos diretamente em /root/webmoney (symlink para /var/www/webmoney) - Mudanças PHP são instantâneas - Mudanças React requerem 'npm run build' - Commit após validação funcional
246 lines
6.5 KiB
Markdown
Executable File
246 lines
6.5 KiB
Markdown
Executable File
# 📚 WebMoney - Documentação
|
|
|
|
## Sistema de Gestão Financeira Pessoal e Empresarial
|
|
|
|
**Versão:** 1.0
|
|
**Data:** Dezembro 2025
|
|
|
|
---
|
|
|
|
## 📖 Documentos Disponíveis
|
|
|
|
### 1. [Manual do Usuário](MANUAL_USUARIO.md)
|
|
Guia completo para usuários finais com instruções detalhadas de como usar cada funcionalidade do sistema.
|
|
|
|
**Conteúdo:**
|
|
- Primeiros passos e configuração inicial
|
|
- Dashboard e visão geral
|
|
- Gestão de contas e transações
|
|
- Categorias e centros de custo
|
|
- Importação de extratos
|
|
- Passivos e financiamentos
|
|
- Transações recorrentes
|
|
- Detecção de transferências e reembolsos
|
|
|
|
---
|
|
|
|
### 2. [Documento Institucional](DOCUMENTO_INSTITUCIONAL.md)
|
|
Conteúdo para website, marketing e comunicação institucional.
|
|
|
|
**Conteúdo:**
|
|
- Taglines e propostas de valor
|
|
- Descrições (curta, média, longa)
|
|
- Lista completa de funcionalidades
|
|
- Público-alvo e personas
|
|
- Diferenciais competitivos
|
|
- Casos de uso
|
|
- Especificações técnicas resumidas
|
|
- FAQ
|
|
- Conteúdo para redes sociais
|
|
|
|
---
|
|
|
|
### 3. [Referência da API](API_REFERENCE.md)
|
|
Documentação técnica completa de todos os endpoints da API REST.
|
|
|
|
**Conteúdo:**
|
|
- Autenticação
|
|
- Endpoints de Contas
|
|
- Endpoints de Transações
|
|
- Endpoints de Categorias
|
|
- Endpoints de Centros de Custo
|
|
- Endpoints de Importação
|
|
- Endpoints de Passivos
|
|
- Endpoints de Recorrências
|
|
- Endpoints de Detecção
|
|
- Endpoints de Dashboard
|
|
|
|
---
|
|
|
|
## 🏗️ Estrutura do Projeto
|
|
|
|
```
|
|
webmoney/
|
|
├── backend/ # Laravel 12 (PHP 8.4)
|
|
│ ├── app/
|
|
│ │ ├── Http/Controllers/Api/
|
|
│ │ │ ├── AccountController.php
|
|
│ │ │ ├── AuthController.php
|
|
│ │ │ ├── CategoryController.php
|
|
│ │ │ ├── CostCenterController.php
|
|
│ │ │ ├── DashboardController.php
|
|
│ │ │ ├── ImportController.php
|
|
│ │ │ ├── LiabilityAccountController.php
|
|
│ │ │ ├── RecurringTemplateController.php
|
|
│ │ │ ├── TransactionController.php
|
|
│ │ │ └── TransferDetectionController.php
|
|
│ │ └── Models/
|
|
│ │ ├── Account.php
|
|
│ │ ├── Category.php
|
|
│ │ ├── CostCenter.php
|
|
│ │ ├── LiabilityAccount.php
|
|
│ │ ├── RecurringTemplate.php
|
|
│ │ ├── RecurringInstance.php
|
|
│ │ ├── Transaction.php
|
|
│ │ └── User.php
|
|
│ ├── database/
|
|
│ │ └── migrations/
|
|
│ ├── routes/
|
|
│ │ └── api.php
|
|
│ └── storage/
|
|
│ └── app/private/imports/
|
|
│
|
|
├── frontend/ # React 18 + Vite 7
|
|
│ ├── src/
|
|
│ │ ├── components/
|
|
│ │ ├── context/
|
|
│ │ ├── hooks/
|
|
│ │ ├── i18n/
|
|
│ │ │ ├── es.json
|
|
│ │ │ ├── en.json
|
|
│ │ │ └── pt-BR.json
|
|
│ │ ├── pages/
|
|
│ │ │ ├── Accounts.jsx
|
|
│ │ │ ├── Categories.jsx
|
|
│ │ │ ├── CostCenters.jsx
|
|
│ │ │ ├── Dashboard.jsx
|
|
│ │ │ ├── ImportTransactions.jsx
|
|
│ │ │ ├── LiabilityAccounts.jsx
|
|
│ │ │ ├── Login.jsx
|
|
│ │ │ ├── RecurringTransactions.jsx
|
|
│ │ │ ├── RefundDetection.jsx
|
|
│ │ │ ├── Register.jsx
|
|
│ │ │ ├── TransactionsByWeek.jsx
|
|
│ │ │ └── TransferDetection.jsx
|
|
│ │ └── services/
|
|
│ │ └── api.js
|
|
│ └── public/
|
|
│
|
|
├── docs/ # Documentação
|
|
│ ├── README.md # Este arquivo
|
|
│ ├── MANUAL_USUARIO.md # Manual do usuário
|
|
│ ├── DOCUMENTO_INSTITUCIONAL.md # Conteúdo institucional
|
|
│ └── API_REFERENCE.md # Referência da API
|
|
│
|
|
└── docker/ # Configuração Docker (opcional)
|
|
```
|
|
|
|
---
|
|
|
|
## 🔧 Stack Tecnológico
|
|
|
|
### Backend
|
|
| Tecnologia | Versão | Uso |
|
|
|------------|--------|-----|
|
|
| PHP | 8.4 | Linguagem principal |
|
|
| Laravel | 12 | Framework web |
|
|
| Sanctum | - | Autenticação API |
|
|
| SQLite/MySQL | - | Banco de dados |
|
|
|
|
### Frontend
|
|
| Tecnologia | Versão | Uso |
|
|
|------------|--------|-----|
|
|
| React | 18 | Framework UI |
|
|
| Vite | 7 | Build tool |
|
|
| Bootstrap | 5 | Estilização |
|
|
| react-i18next | - | Internacionalização |
|
|
| Chart.js | - | Gráficos |
|
|
|
|
### Infraestrutura
|
|
| Tecnologia | Uso |
|
|
|------------|-----|
|
|
| Nginx | Web server |
|
|
| PHP-FPM | Process manager |
|
|
| Docker | Containerização (opcional) |
|
|
|
|
---
|
|
|
|
## 🌐 Idiomas Suportados
|
|
|
|
| Código | Idioma | Arquivo |
|
|
|--------|--------|---------|
|
|
| pt-BR | Português (Brasil) | i18n/pt-BR.json |
|
|
| es | Español | i18n/es.json |
|
|
| en | English | i18n/en.json |
|
|
|
|
---
|
|
|
|
## 💱 Moedas Suportadas
|
|
|
|
| Código | Moeda | Símbolo |
|
|
|--------|-------|---------|
|
|
| BRL | Real Brasileiro | R$ |
|
|
| EUR | Euro | € |
|
|
| USD | Dólar Americano | $ |
|
|
| GBP | Libra Esterlina | £ |
|
|
| JPY | Iene Japonês | ¥ |
|
|
|
|
---
|
|
|
|
## 📊 Resumo de Funcionalidades
|
|
|
|
| Módulo | Funcionalidades |
|
|
|--------|-----------------|
|
|
| **Contas** | CRUD, multi-tipo, multi-moeda, ajuste de saldo |
|
|
| **Transações** | CRUD, split, transferência, completar, cancelar |
|
|
| **Categorias** | Hierárquicas, palavras-chave, categorização em lote |
|
|
| **Centros de Custo** | CRUD, palavras-chave |
|
|
| **Importação** | CSV, XLSX, OFX, PDF, mapeamentos salvos |
|
|
| **Passivos** | Importação PDF, parcelas, conciliação |
|
|
| **Recorrências** | Templates, instâncias, pausar/retomar |
|
|
| **Detecção** | Transferências e reembolsos automáticos |
|
|
| **Dashboard** | Resumo, cashflow, calendário, alertas |
|
|
|
|
---
|
|
|
|
## 🚀 Deploy
|
|
|
|
### Produção
|
|
- **Servidor:** 213.165.93.60
|
|
- **Domínio:** webmoney.cnxifly.com
|
|
- **Protocolo:** HTTPS (Let's Encrypt)
|
|
|
|
### Comandos Úteis
|
|
|
|
```bash
|
|
# Backend - Rodar migrations
|
|
php artisan migrate
|
|
|
|
# Backend - Limpar cache
|
|
php artisan cache:clear
|
|
php artisan config:clear
|
|
php artisan route:clear
|
|
|
|
# Frontend - Build de produção
|
|
npm run build
|
|
|
|
# Frontend - Desenvolvimento
|
|
npm run dev
|
|
```
|
|
|
|
---
|
|
|
|
## 📝 Notas de Versão
|
|
|
|
### v1.0.0 (Dezembro 2025)
|
|
- Lançamento inicial
|
|
- Todas as funcionalidades core implementadas
|
|
- Multi-idioma (PT-BR, ES, EN)
|
|
- Multi-moeda
|
|
- Importação universal
|
|
- Categorização automática
|
|
- Passivos e recorrências
|
|
- Detecção inteligente
|
|
|
|
---
|
|
|
|
## 📞 Contato
|
|
|
|
- **Desenvolvedor:** Marco Leite
|
|
- **Email:** marco@cnxifly.com
|
|
- **Sistema:** webmoney.cnxifly.com
|
|
|
|
---
|
|
|
|
*WebMoney - Sua gestão financeira simplificada*
|