96 lines
3.4 KiB
Markdown
96 lines
3.4 KiB
Markdown
# DRE Gerencial - Documentação do Sistema
|
|
|
|
## Visão Geral
|
|
|
|
O **DRE Gerencial** é um sistema web desenvolvido em Next.js para análise e visualização de dados financeiros através de uma Demonstração do Resultado do Exercício (DRE) hierárquica e interativa.
|
|
|
|
## Objetivo Principal
|
|
|
|
O sistema tem como objetivo principal fornecer uma interface intuitiva para análise de dados financeiros empresariais, permitindo:
|
|
|
|
- Visualização hierárquica de dados financeiros (Grupo → Subgrupo → Centro de Custo → Conta)
|
|
- Análise temporal por períodos mensais
|
|
- Drill-down analítico para detalhamento de transações
|
|
- Exportação de dados para Excel
|
|
- Cálculo de percentuais baseados em grupos de referência
|
|
|
|
## Características Principais
|
|
|
|
### 1. **Interface Hierárquica**
|
|
- Estrutura em árvore expansível (Grupo → Subgrupo → Centro de Custo → Conta)
|
|
- Visualização de valores e percentuais por mês
|
|
- Ordenação por descrição ou valor total
|
|
- Seleção de linhas para análise detalhada
|
|
|
|
### 2. **Análise Analítica**
|
|
- Drill-down a partir de qualquer nível hierárquico
|
|
- Filtros por período, centro de custo, grupo, subgrupo e conta
|
|
- Visualização detalhada de transações individuais
|
|
- Exportação para Excel com múltiplas abas
|
|
|
|
### 3. **Cálculos Automáticos**
|
|
- Percentuais baseados no Grupo 03 como referência
|
|
- Totais consolidados por nível hierárquico
|
|
- Valores por mês com formatação monetária brasileira
|
|
|
|
## Estrutura do Projeto
|
|
|
|
```
|
|
src/
|
|
├── app/
|
|
│ ├── api/
|
|
│ │ ├── analitico/route.ts # API para dados analíticos
|
|
│ │ └── dre/route.ts # API para dados DRE
|
|
│ ├── DRE/
|
|
│ │ ├── analitico.tsx # Componente de análise analítica
|
|
│ │ ├── page.tsx # Página principal
|
|
│ │ └── teste.tsx # Componente principal DRE
|
|
│ └── layout.tsx # Layout da aplicação
|
|
├── components/
|
|
│ └── ui/ # Componentes UI reutilizáveis
|
|
├── db/
|
|
│ ├── index.ts # Configuração do banco
|
|
│ └── schema.ts # Schema do banco de dados
|
|
└── lib/
|
|
└── utils.ts # Utilitários
|
|
```
|
|
|
|
## Tecnologias Utilizadas
|
|
|
|
- **Frontend**: Next.js 15, React 19, TypeScript
|
|
- **Styling**: Tailwind CSS 4
|
|
- **Database**: PostgreSQL com Drizzle ORM
|
|
- **UI Components**: Radix UI, Lucide React
|
|
- **Export**: XLSX para Excel
|
|
|
|
## Documentação Detalhada
|
|
|
|
- [Arquitetura do Sistema](./architecture.md)
|
|
- [Banco de Dados](./database.md)
|
|
- [APIs](./api.md)
|
|
- [Componentes](./components.md)
|
|
- [Guia de Desenvolvimento](./development.md)
|
|
- [Deploy e Configuração](./deployment.md)
|
|
- [Troubleshooting](./troubleshooting.md)
|
|
|
|
## Quick Start
|
|
|
|
1. Instalar dependências: `npm install`
|
|
2. Configurar variáveis de ambiente (ver [Deploy](./deployment.md))
|
|
3. Executar: `npm run dev`
|
|
4. Acessar: `http://localhost:3000/DRE`
|
|
|
|
## Manutenção
|
|
|
|
Para manter o sistema sem perder suas características:
|
|
|
|
1. **Preserve a hierarquia**: Grupo → Subgrupo → Centro de Custo → Conta
|
|
2. **Mantenha os cálculos**: Percentuais baseados no Grupo 03
|
|
3. **Conserve a funcionalidade**: Drill-down e exportação Excel
|
|
4. **Atualize dados**: Mantenha sincronização com fonte de dados
|
|
5. **Teste filtros**: Valide todos os filtros analíticos
|
|
|
|
---
|
|
|
|
*Última atualização: $(date)*
|