How k0a1a/hotglue2 works
Main Components Structure
a. Client-Side Layer
• Main frontend components (/js, /css directories)
• JavaScript modules (jQuery, editing interfaces)
b. Server-Side Layer
• Core PHP components (controller.inc.php, common.inc.php)
• Module system (modules.inc.php and individual modules)
• Authentication system (indicated by AUTH_METHOD in README)
c. Storage Layer
• Content storage (/content directory)
• Configuration storage (user-config.inc.php)
Module System Architecture
• Core module handler
• Individual module types with their relationships:
• Content modules (text, image, video, webvideo)
• Utility modules (transform, lock)
• Interface modules (page_browser, revisions_browser)
Request Flow
Flow of requests through:
• Apache/.htaccess routing
• Controller layer
• Module processing
• Response generation
Use these visual elements:
Components
• Blue rectangles: Core system components
• Green rectangles: Modules
• Yellow rectangles: Client-side components
• Gray rectangles: External services/dependencies
Connections
• Double lines: Data flow
Labels
• Component names
• Key interfaces
• Authentication points
• Cache locations
Specific Guidelines:
A high-level overview showing
[Client Browser] ←→ [Web Server (Apache)] ←→ [HOTGLUE Core] ←→ [Module System]
• ↕
• [Storage Layer]
Then break down the Module System
[Module Handler]
• ↓
[Module Types]
• Content Modules (text, image, video)
• Utility Modules (transform, lock)
• Interface Modules (browsers, welcome)
URL Request → .htaccess → controller.inc.php → Module Processing → HTML Generation → Response
Important Considerations:
• Authentication system as it's a critical component
• Caching mechanisms (mentioned in README as important)
• File upload handling (noted as having specific requirements)
• HTTPS considerations for external services (mentioned for Vimeo)
• Where configuration options affect the system
This approach will provide a comprehensive view of the system while maintaining clarity about how components interact and how data flows through the application.