How aprnna/vouki works
Project type and purpose
• This is a full-stack Laravel web application for managing events, categories, skills, volunteers and reviews.
• It exposes browser-facing views (Blade templates + compiled JS/CSS), a set of HTTP controllers implementing authentication, event CRUD, profile management, and uses Eloquent models to interact with a MySQL (or equivalent) database.
• It also integrates external services: Google OAuth for login, email for verification/notifications, and LeafletJS for map display.
File structure
• Top-level “app/Http/Controllers” contains MVC controllers grouped by feature (Auth, Event, Category, Profile, etc.).
• “app/Models” holds Eloquent models representing DB tables: User, Event, Category, Skill, Review, Questions, Answers, VolunteerEvent, UserDetail.
• “resources/views” contains Blade templates organized by feature: auth, events, profile, components, layouts.
• “resources/js” + “resources/css” + Vite: front-end asset pipeline.
• “database/migrations” + “factories” + “seeders”: DB schema, test data.
• “config” directory: store framework, database, mail, queue, filesystem, and leaflet setup.
• “routes/web.php” & “routes/auth.php”: HTTP endpoints.
• “public/index.php” is the front controller for all incoming HTTP.
README for additional insights
• Standard Laravel installation, build & serve instructions.
a. Main components
• Client (Browser/Mobile)
• Web Server (Apache/Nginx) → PHP-FPM → Laravel Application
• Route/Controller Layer
• Service/Domain Layer (optional services in Providers)
• Data Access Layer (Eloquent Models + Query Builder)
• MySQL/PostgreSQL Database
• Cache (Redis or file)
• Queue (Redis or database) for background jobs (email, notifications)
• Storage (Local disk or S3) for user uploads
• External Services:
• Google OAuth (Auth API)
• Mailgun/SMTP (Email)
• Leaflet tile servers (Map)
b. Relationships & interactions
• User → HTTP(S) request → Web Server → Laravel Router → Controller
• Controller → invokes FormRequest validation → calls Model/service → returns data → passes to Blade view → rendered HTML → response to user
• Controller → dispatches Jobs to Queue (e.g., send email)
• Queue Worker → picks up Job → interacts with Mail Service API or other external API
• Eloquent Model → reads/writes to DB via database connection
• Views → load compiled JS/CSS from public assets (Vite build manifest)
• resources/js/map.js → calls Leaflet external tile service
• Auth flow → Laravel Socialite/GoogleAuthController → directs user to Google → callback → fetches user info → stores token/session
c. Architectural patterns / design principles
• MVC: Controllers, Models, Views
• Layered architecture: HTTP → Controllers → Services → Models → Database
• Dependency injection via Service Providers
• Event-driven / asynchronous work via Laravel Queues
• Use of FormRequest for validation (Separation of concerns)
• Blade Components for reusable UI pieces
d. Key technologies, frameworks, libraries
• Laravel Framework (MVC, Eloquent ORM, Queue, Events)
• PHP-FPM / Apache or Nginx
• MySQL / PostgreSQL
• Redis (cache & queue back-end) or database queue
• Vite + Laravel Mix or NPM for asset bundling
• Blade templating + Alpine.js (if used)
• LeafletJS for maps
• Socialite for Google OAuth
• PHPUnit / Pest for testing
Essential architectural elements to capture
• MVC layers & folder mappings
• Asset pipeline & public directory
• DB & cache back-ends
• Queue system for background jobs
• External integrations (OAuth, Email, Maps)
• Storage linking (local/S3)