How gamonoid/icehrm works
Main System Components
The system should be represented with these key components:
a) Frontend Layer:
• Web Interface (/web directory)
• Admin Module (/web/admin)
• User Module (/web/modules)
• Components (/web/components)
• Static Assets (CSS, JS, images)
b) Backend Layer:
• Core Application (/core)
• API Services (/app/api)
• Authentication System
• File Upload Service
• Extension System
c) Data Layer:
• Database (MySQL/MariaDB)
• File Storage System
• Cache System
Key Architectural Patterns to Highlight
a) MVC Architecture:
• Models (/core/src/*/Common/Model)
• Views (/web/modules/src)
• Controllers (/core/src/*/Admin/Api)
b) Module-based Architecture:
• Admin Modules
• User Modules
• Core Modules
• Custom Extensions
Integration Points
Connections for:
• REST API endpoints
• Database connections
• File system interactions
• External services (Google, SAML)
Specific Implementation Details
Specialized components:
• Migration System (/core/migrations)
• Cron Jobs (/core/crons)
• Extension System (/extensions)
• Multi-language Support (/core/lang)
┌─────────────────────────────────────────────────────┐
• Client Layer │
• ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
• Admin UI │ │ User UI │ │ Public Pages│ │
• ┘ └─────────────┘ └─────────────┘ │
• ┤
• Application Layer │
• ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
• Core API │ │ Modules │ │ Extensions │ │
• ┘ └─────────────┘ └─────────────┘ │
• ┤
• Service Layer │
• ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
• Auth Service│ │File Service │ │ Job Service │ │
• ┘ └─────────────┘ └─────────────┘ │
• ┤
• Data Layer │
• ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
• Database │ │File Storage │ │ Cache │ │
• ┘ └─────────────┘ └─────────────┘ │
• ┘
Connection Types
• Dependencies (thin lines)
Additional Elements
Include:
• Docker containers (from docker-compose files)
• Development tools
• Testing infrastructure
• Deployment paths
Remember to highlight the modular nature of the system and how it can be extended through the custom extension system, which is a key feature of IceHrm.