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:
- 00_INDICE.md - Índice completo e organização lógica de toda a documentação
- ../CONTEXT.md - Contexto arquitetural imutável do sistema
- ../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ê.
- Suba os containers Docker (se estiver usando Docker):
docker-compose up -d - Acesse o instalador no seu navegador:
http://localhost/install - 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 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 - Regras operacionais e convenções (FONTE DA VERDADE)
- 01_COMPORTAMENTO_IA.md - Comportamento esperado da IA
- 03_MODULOS.md - Sistema de módulos e estrutura
- 05_PADROES_CODIGO.md - Padrões de código e estilo
- 50_LAYOUTS_CORRETOS.md - Layouts Twig corretos
- 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 para a lista completa de regras críticas, incluindo:
- NUNCA alterar arquivos do Core (kernel/, app/Controllers/, app/Models/)
- NUNCA alterar módulos com
ready: true(exceto correção de bugs reportados) - NUNCA gravar arquivos em
public/(usarstorage/uploads/) - NUNCA usar FontAwesome (apenas Bootstrap Icons)
- SEMPRE usar DataTables para tabelas de listagem
- 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 para a política completa de uso de memórias core.
🤝 Contribuição
Se você deseja contribuir com o projeto, por favor leia primeiro:
- 00_INDICE.md - Para entender a organização
- RULES.md - Para seguir as convenções do projeto
- 01_COMPORTAMENTO_IA.md - Para entender autonomia vs preservação
Última Atualização: 2025-01-19 Versão: 2.0.0
© SysCMS Team