How orchidsoftware/platform works
Project Type & Purpose
• This is a Laravel package (“orchid/platform”), not a standalone application.
• Purpose: provide a code-driven back-office framework (admin panels, dashboards) for Laravel, with form builders, filtering, notifications, SPA-like UX via Hotwire/Turbo, and scaffolding commands.
High-Level Components
A. Front-end (Client Layer)
• public/assets/app.js + Stimulus controllers (resources/js/controllers)
• public/assets/app.css (Sass compiled from resources/sass)
• Turbo frames/streams for partial updates (Hotwire)
B. Application (Server Layer)
• Laravel HTTP Kernel & Middleware (config/platform.php, src/Platform/Http/Middleware)
• Routes (routes/auth.php, routes/dashboard.php + stubbed routes)
• Controllers (src/Platform/Http/Controllers + AsyncController, AttachmentController, IndexController, etc.)
• “Screens” abstraction (src/Screen & src/Platform/Http/Screens)—encapsulates page logic, actions, layouts
• Blade Views & Layouts (resources/views + platform-provided partials)
• ServiceProvider (OrchidServiceProvider) which binds facades, publishes assets, registers commands, events, routes
• Artisan Commands (src/Platform/Commands)—generator commands for screens, fields, filters, layouts, stubs
• Core Modules:
– Attachment (src/Attachment: engines, models, contracts)
– Alert/Toast (src/Alert)
– Access Control (src/Access: roles, permissions, impersonation)
– Filters & Sorting (src/Filters)
– Metrics (src/Metrics)
– Support & Facades (src/Support)
C. Persistence (Data Layer)
• Database migrations & seeders (database/migrations, database/seeders)
• Eloquent Models (src/Platform/Models + Attachment models)
• Laravel Scout / Search integration (optional)
• File storage for attachments (config/platform.php + Events & Listeners)
D. CLI & Events
• Artisan CLI commands (scaffolding/stubs in stubs/)
• Event system (src/Platform/Events) for InstallEvent, UploadFileEvent, etc.
Relationships & Data Flow
1. Browser → HTTP Request → Laravel Kernel
2. Kernel → Middleware (Access, Turbo, BladeIcons) → Route resolution
3. Route → Platform/Screen Controller → Screen class
4. Screen → Queries/Repositories → Eloquent Models → Database
5. Screen → Build Layout → Render Blade View → Turbo frame/HTML response
6. Client (Stimulus) intercepts links/forms → issues Turbo requests → async controllers → JSON/HTML fragments → updates DOM
7. Actions (filters, attach/upload) → AttachmentController → Storage → Events → Notifications
8. Artisan (CLI) → OrchidServiceProvider → Command classes → generate stubs → publish package resources
Architectural Patterns & Design Principles
• MVC + “Screen” abstraction over Controllers & Views
• Service Provider / Service Container for binding facades & commands
• Command Pattern for scaffolding & publishing resources
• Event-Driven design for file uploads, role changes, installation hooks
• Eloquent ORM for data access; Repositories for Queries
• Stimulus + Hotwire/Turbo for SPA-like UX