How ascoor/almadar works
Project type and purpose
• This is a full-stack web application (“Almadar”) for legal and administrative management.
• Backend: Laravel 10 (PHP 8.2) providing RESTful APIs, business logic, authentication/authorization, events & notifications, PDF/text processing, database migrations/seeders.
• Frontend: React 18 + Vite + Tailwind CSS + PWA for a responsive single-page UI (dashboard, user management, litigations, contracts, investigations, legal advices, reports, settings, archive, profile).
File structure
• Top-level:
• backend/ – Laravel app (MVC in app/, config, routes/, database/, resources/, public/).
• frontend/ – React app (public/, src/ with components/pages/services/hooks/context).
• start.sh – local startup script.
• Backend folders:
• app/Models, Controllers, Events, Notifications, Providers.
• routes/api.php & web.php.
• config/ includes CORS, auth, queue, sanctum, spatie/permission.
• database/ migrations & seeders.
• public/index.php as entry point.
• Frontend folders:
• src/components – feature-organized UI components (Contracts, Investigations, LegalAdvices, Litigations, Notifications, Settings, Users, auth, common, dashboard, ui).
• src/pages – route-level page components.
• src/services/api – axios-based wrappers for backend endpoints.
• src/context & hooks – React Context and custom hooks for state, Pusher/Echo integration.
• public/ assets and manifest for PWA.
README for additional insights
• Confirms high-level modules (dashboard, user management, litigations, contracts, investigations, legal project management, legal advices, reports, settings, archive, profile).
• Lists key libraries: Laravel Sanctum, Spatie/permission, phpword, pdf-to-text, React Router, react-pdf, tesseract.js, pusher-js, sonner.
• Emphasizes responsive layout, notification system, PDF viewer.
Elements
• Components labeled: React SPA, Laravel API, Database, Cache/Queue, File Storage, External Services
• HTTP requests/responses
• Event broadcasting/receiving
• Read/write to database/storage/queue
• Frontend (blue rectangles)