How to-heeb/nigerians-at-faang works
Project type and purpose
• This is a full-stack web application (“Nigerians @ FAANG”) built with Laravel 12 (PHP 8.2), Blade (server-side templates), Livewire (reactive components), and Filament 4 (admin dashboard).
• Purpose: public site for browsing profiles and blogs of Nigerians at Big Tech, plus an admin panel to manage content.
Main components
a. Clients
• Public users (browser/mobile)
• Admin users (browser/mobile, access Filament at /admin)
b. Edge & Delivery
• Web Server (Apache or Nginx + PHP-FPM) serving public assets and routing all HTTP/HTTPS requests to Laravel’s index.php
• CDN or static asset server (optional) serving compiled CSS/JS/images from /public
c. Application Tier (Laravel monolith)
• HTTP Kernel → Routing → Controllers (AboutController, BlogController, etc.)
• Livewire components (Blogs, Companies, Profiles, Tags)
• Filament admin panel resources (BlogResource, CompanyResource, etc.)
• Console Commands & Scheduled Jobs (e.g., BuildSitemap)
• Job Dispatch (e.g., IncrementViews job) into a queue
d. Data & State
• Primary database (MySQL) for all Eloquent models (users, blogs, companies, etc.)
• Cache/Session store (Redis or file)
• Queue backend (Redis, database, or other)
• File storage (local /storage or external S3‐compatible) for uploaded media
e. External Services
• SMTP provider (Mailgun, SES, SMTP) for notifications (contact us, subscriber verification, welcome email)
• Analytics (Google Analytics via config/analytics.php)
• Optional third-party integrations via config/services.php
f. CI/CD Pipeline
• GitHub repo with Actions workflows (“test-deploy_staging.yaml” & “test-deploy_production.yaml”)
• Build steps: composer install, npm install & npm run dev, phpunit tests, deployment scripts
• Environment management: encrypted .env.staging and .env.production
Relationships and interactions
• Controllers call Eloquent → MySQL
• Livewire requests return JSON + HTML snippets
• Filament routes → admin CRUD interfaces
Architectural patterns & principles
• MVC for public interface (Controllers, Views, Models)
• Server-driven UI with Livewire for interactivity without a separate SPA
• CRUD admin panel via Filament (resource-based scaffolding)
• Asynchronous jobs for non-blocking tasks (email, view counters, sitemap build)
• Environment segregation (local, staging, production) with encrypted .env files and CI gating