Michael Schiemer
55a330b223
- Add DISCOVERY_LOG_LEVEL=debug - Add DISCOVERY_SHOW_PROGRESS=true - Temporary changes for debugging InitializerProcessor fixes on production
81 lines
4.6 KiB
Markdown
81 lines
4.6 KiB
Markdown
# Framework Documentation
|
|
|
|
> Comprehensive documentation for the custom PHP framework with modern architecture patterns, advanced caching, and powerful view system.
|
|
|
|
## 📚 Documentation Overview
|
|
|
|
### Framework Core
|
|
- **[Framework Overview](framework/index.md)** - Core framework concepts and patterns
|
|
- **[HTTP Layer](framework/http/README.md)** - Request/response handling and middleware
|
|
- **[Database & ORM](database/eager-loading.md)** - EntityManager, N+1 elimination, change tracking
|
|
- **[View System](framework/views/overview.md)** - Template processing and component system
|
|
- **[Dependency Injection](framework/di/README.md)** - Container and service management
|
|
- **[Analytics System](framework/analytics/README.md)** - Performance monitoring and metrics
|
|
- **[Core Components](framework/core/README.md)** - Discovery, routing, and bootstrapping
|
|
|
|
### Design System
|
|
- **[Design Foundations](design-system/foundations.md)** - Colors, typography, spacing, and design tokens
|
|
- **[CSS Architecture](design-system/css-architecture.md)** - ITCSS structure and methodology
|
|
- **[JavaScript Modules](design-system/javascript.md)** - ES6 component system
|
|
- **[Admin Interface](design-system/admin/overview.md)** - Admin-specific design patterns
|
|
|
|
### Development & Standards
|
|
- **[Setup Guide](SETUP.md)** - Development environment setup
|
|
- **[Coding Guidelines](standards/CODING-GUIDELINES.md)** - Code standards and best practices
|
|
- **[Security Guidelines](standards/SICHERHEITS-GUIDELINES.md)** - Security standards
|
|
- **[Testing Guidelines](guidelines/TESTING-GUIDELINES.md)** - Testing strategies and patterns
|
|
- **[Performance Guidelines](guidelines/PERFORMANCE-GUIDELINES.md)** - Optimization techniques
|
|
- **[Deployment Guide](DEPLOYMENT.md)** - Production deployment strategies
|
|
|
|
### Database & Advanced Features
|
|
- **[Database Master/Slave Router](database/master-slave-router.md)** - Connection management and load balancing
|
|
- **[Database Change Tracking](database/change-tracking.md)** - Entity change tracking and audit logs
|
|
- **[Database Eager Loading](database/eager-loading.md)** - N+1 query elimination and performance optimization
|
|
- **[Phone Number Validation](validation/phone-number.md)** - Phone number handling and validation
|
|
- **[Unit of Work Pattern](UnitOfWork.md)** - Database transaction management
|
|
- **[Worker System](WORKER.md)** - Background job processing and queues
|
|
|
|
### Architecture & Patterns
|
|
- **[System Architecture](architecture/STRUKTUR-DOKUMENTATION.md)** - Overall system structure
|
|
- **[Module System](framework/MODUL-CHECKLISTE.md)** - Module development checklist
|
|
- **[Extension Patterns](framework/ERWEITERUNGSPATTERN.md)** - Framework extension patterns
|
|
|
|
### Development Tools & AI
|
|
- **[AI Assistant Setup](ai/EINRICHTUNG-PHPSTORM.md)** - PhpStorm AI integration
|
|
- **[AI Guidelines](ai/GUIDELINES-FÜR-AI-ASSISTANT.md)** - Best practices for AI assistance
|
|
- **[API Documentation](api.md)** - API reference and examples
|
|
- **[Environment Setup](ENV.md)** - Environment configuration
|
|
- **[Git Workflows](COMMITS.md)** - Commit standards and workflows
|
|
|
|
## 🚀 Quick Start Guide
|
|
|
|
### For New Developers
|
|
1. **[Setup Guide](SETUP.md)** - Get your development environment running
|
|
2. **[System Architecture](architecture/STRUKTUR-DOKUMENTATION.md)** - Understand the system structure
|
|
3. **[Coding Guidelines](standards/CODING-GUIDELINES.md)** - Learn the coding standards
|
|
4. **[Module Checklist](framework/MODUL-CHECKLISTE.md)** - Framework module development
|
|
|
|
### For Designers
|
|
1. **[CSS Architecture](design-system/css-architecture.md)** - Understand the CSS structure
|
|
2. **[Admin Interface](design-system/admin/overview.md)** - Admin design patterns
|
|
3. **[JavaScript Modules](design-system/javascript.md)** - Frontend component system
|
|
|
|
### For DevOps
|
|
1. **[Deployment Guide](DEPLOYMENT.md)** - Production deployment
|
|
2. **[Performance Guidelines](guidelines/PERFORMANCE-GUIDELINES.md)** - Optimization techniques
|
|
3. **[Security Guidelines](standards/SICHERHEITS-GUIDELINES.md)** - Security best practices
|
|
|
|
## 📊 Framework Features
|
|
|
|
- **Modern PHP 8.4** - Latest language features and performance
|
|
- **Attribute-based Architecture** - Clean, discoverable component system
|
|
- **Advanced ORM** - N+1 elimination, change tracking, master/slave routing
|
|
- **DOM-based Templates** - Powerful view processing with component system
|
|
- **Multi-level Caching** - Intelligent caching with automatic invalidation
|
|
- **AI Integration** - MCP protocol for AI development tools
|
|
- **Performance Monitoring** - Built-in analytics and optimization tools
|
|
|
|
---
|
|
|
|
*This documentation is continuously updated. For contributions, see our [contribution guidelines](standards/CODING-GUIDELINES.md).*
|