102 lines
3.9 KiB
Markdown
Executable File
102 lines
3.9 KiB
Markdown
Executable File
# SysCMS - Documentação de Regras
|
|
|
|
**SysCMS** é um sistema de gerenciamento de conteúdo moderno, modular e flexível, construído em PHP 8.1+, MySQL e Bootstrap 5.
|
|
|
|
## 📖 Começando
|
|
|
|
Para navegar pela documentação de forma eficiente, comece por:
|
|
|
|
1. **[00_INDICE.md](00_INDICE.md)** - Índice completo e organização lógica de toda a documentação
|
|
2. **[../CONTEXT.md](../CONTEXT.md)** - Contexto arquitetural imutável do sistema
|
|
3. **[../RULES.md](RULES.md)** - Regras operacionais e convenções do projeto
|
|
|
|
## 🚀 Início Rápido
|
|
|
|
### Instalação Automática
|
|
|
|
O SysCMS possui um instalador web que configura tudo para você.
|
|
|
|
1. Suba os containers Docker (se estiver usando Docker):
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
2. Acesse o instalador no seu navegador:
|
|
```
|
|
http://localhost/install
|
|
```
|
|
3. Siga os passos na tela para configurar banco de dados e usuário admin.
|
|
|
|
> **Nota:** Se não estiver usando Docker, certifique-se ter um servidor web (Apache/Nginx) apontando para a pasta `public/` e PHP 8.1+ configurado.
|
|
|
|
---
|
|
|
|
## 📚 Estrutura da Documentação
|
|
|
|
A documentação está organizada em categorias numeradas para facilitar a navegação. Consulte o **[00_INDICE.md](00_INDICE.md)** para ver a estrutura completa.
|
|
|
|
### Categorias Principais:
|
|
|
|
- **Fundamentos (01-09)**: Conceitos base e comportamentos essenciais
|
|
- **Ciclo de Vida (10-19)**: Fluxo de execução e ciclo de vida da aplicação
|
|
- **Implementação (20-29)**: Guias práticos para criação e implementação
|
|
- **Específicos (50-59)**: Regras específicas para funcionalidades pontuais
|
|
|
|
### Documentos Essenciais:
|
|
|
|
- **[RULES.md](RULES.md)** - Regras operacionais e convenções (FONTE DA VERDADE)
|
|
- **[01_COMPORTAMENTO_IA.md](01_COMPORTAMENTO_IA.md)** - Comportamento esperado da IA
|
|
- **[03_MODULOS.md](03_MODULOS.md)** - Sistema de módulos e estrutura
|
|
- **[05_PADROES_CODIGO.md](05_PADROES_CODIGO.md)** - Padrões de código e estilo
|
|
- **[50_LAYOUTS_CORRETOS.md](50_LAYOUTS_CORRETOS.md)** - Layouts Twig corretos
|
|
- **[51_UPLOADS_STORAGE.md](51_UPLOADS_STORAGE.md)** - Regras de uploads e storage
|
|
|
|
---
|
|
|
|
## 🛠️ Tecnologias Principais
|
|
|
|
- **Backend**: PHP 8.1+, PHP-DI, FastRoute, Symfony Console
|
|
- **Database**: MySQL 8.0, Illuminate Database (Eloquent ORM)
|
|
- **Frontend**: Bootstrap 5.3, Vanilla JS, Twig Templates
|
|
- **Ícones**: Bootstrap Icons (Exclusivo)
|
|
|
|
---
|
|
|
|
## ⚠️ Regras Críticas
|
|
|
|
Consulte o **[00_INDICE.md](00_INDICE.md)** para a lista completa de regras críticas, incluindo:
|
|
|
|
1. NUNCA alterar arquivos do Core (kernel/, app/Controllers/, app/Models/)
|
|
2. NUNCA alterar módulos com `ready: true` (exceto correção de bugs reportados)
|
|
3. NUNCA gravar arquivos em `public/` (usar `storage/uploads/`)
|
|
4. NUNCA usar FontAwesome (apenas Bootstrap Icons)
|
|
5. SEMPRE usar DataTables para tabelas de listagem
|
|
6. SEMPRE priorizar ERP Legado em caso de conflito
|
|
|
|
## 🧠 Política de Memórias Core
|
|
|
|
As **memórias core são APENAS SUPLEMENTARES** e **NÃO DEVEM SER USADAS COMO FONTE DE VERDADE**.
|
|
|
|
- **Fonte Primária**: Sempre consulte os arquivos de regras (RULES.md, CONTEXT.md, /rules/)
|
|
- **Uso de Memórias**: Apenas como atalhos rápidos para informações estáticas (credenciais, URLs de API)
|
|
- **Conflito**: Arquivos de regras sempre prevalecem sobre memórias core
|
|
- **Sem Redundância**: As memórias core foram limpas para não duplicar informações dos arquivos de regras
|
|
|
|
Consulte o **[00_POLITICA_MEMORIAS_CORE.md](00_POLITICA_MEMORIAS_CORE.md)** para a política completa de uso de memórias core.
|
|
|
|
---
|
|
|
|
## 🤝 Contribuição
|
|
|
|
Se você deseja contribuir com o projeto, por favor leia primeiro:
|
|
|
|
1. **[00_INDICE.md](00_INDICE.md)** - Para entender a organização
|
|
2. **[RULES.md](RULES.md)** - Para seguir as convenções do projeto
|
|
3. **[01_COMPORTAMENTO_IA.md](01_COMPORTAMENTO_IA.md)** - Para entender autonomia vs preservação
|
|
|
|
---
|
|
|
|
**Última Atualização**: 2025-01-19
|
|
**Versão**: 2.0.0
|
|
|
|
© SysCMS Team
|