How hoceineel/abi-zaid-quran works
Project type and purpose
• This is a full-stack monolithic web application (Laravel 11) with an admin dashboard (Filament 3.x), Livewire dynamic components, PWA support and integrations (WhatsApp, PDF reports). It manages Quran memorization schools: students, groups, attendance, progress tracking, communications, and payments.
Main components
a. Frontend
• Browser / PWA client
• Tailwind CSS + Livewire components (QR scanner, charts)
• Filament admin panel UI
b. Backend (Laravel MVC)
• HTTP layer: routes → Controllers (web.php, Console commands)
• Models / Eloquent ORM
• Services layer: WhatsAppService, DisconnectionService, ReceiptService
• Jobs / Queue: SendWhatsAppMessageJob
• Console commands (font installer, test connections, scheduled reminders)
c. Database
• MySQL (or SQLite)
• Tables: users, students, groups, attendances, progresses, payments, reminder_logs, whatsapp_sessions, whatsapp_message_histories, etc.
d. External services
• WhatsApp Business API (sending/receiving messages)
• PDF generation (dompdf)
• PWA service worker (caching, offline)
• Storage (local disk / S3 via Laravel Filesystems)
Relationships & data flows
• User / Guardian / Teacher (browser) → HTTP request → Laravel router → Controller or Livewire component → Service or Model → Database → Response → UI
• Livewire components (e.g., QR scanner) use WebSockets or AJAX calls to backend actions
• Filament dashboard CRUD → Resource classes → Eloquent Models → DB
• Controller or Job enqueues SendWhatsAppMessageJob → Queue worker → WhatsAppService → External WhatsApp API → Guardian’s phone
• PDF report request → ReceiptService → dompdf → PDF output → Browser download
• PWA client fetches serviceworker.js → caches assets → offline support
Architectural patterns & design principles
• MVC separation (Controllers, Models, Views)
• Resource-based admin panel (Filament Resources → Pages → RelationManagers)
• Service layer for business logic (Services folder)
• Asynchronous processing via queue workers (Jobs)
• Single codebase monolith with clear modular subsystems
• PWA enhancements for mobile