How habib9612/fleetbase works
Project type and purpose
• Fleetbase is a full-stack, modular logistics and supply-chain operating system. It combines a Laravel-based REST API (“api/”), an Ember.js single-page application console (“console/”), a collection of shared packages (“packages/”), and infrastructure code for containerization and Kubernetes/Helm deployments (“docker/”, “infra/helm/”).
File structure
• Top‐level orchestrator: docker-compose.yml, CI/CD pipelines (GitHub Actions, GitLab CI), Helm charts.
• Backend (api/): Laravel PHP application with Controllers, Models, Middleware, Sanctum authentication, Artisan CLI, database migrations/seeders, public entry point.
• Frontend (console/): Ember.js app with adapters/serializers/routes/controllers/components/styles, built via Ember CLI, served by Nginx or Caddy in Docker.
• Shared modules (packages/): mono-repo libraries for core-api, CLI tools, Ember UI components, domain engines (IAM, ledger, pallet, registry-bridge, extensions indexer).
• Infrastructure as code: Dockerfiles, Caddyfiles, nginx.conf, Helm templates, environment configs, scripts for package installation and updates.
README for additional insights
• Key features: REST API, sockets/webhooks, extension architecture, IAM, telematics, internationalization.
• Deployment: Docker Compose for local, Helm charts for Kubernetes. Ports: 4200 (console), 8000 (API).
• Integrations: OSRM routing, IPInfo, Google Maps, Twilio, email providers.
• Extensions & CLI: modular plugin framework managed via @fleetbase/cli.
a. Main components
• End users (web browsers, mobile apps)
• Fleetbase Console (Ember.js SPA)
• Fleetbase API (Laravel REST + WebSocket)
• Shared services: SocketCluster real-time layer, Webhooks engine
• Data stores: MySQL (core database), Redis (cache, session, pub/sub), file storage (local or S3)
• Extensions subsystem (dynamically loaded modules)
• Fleetbase CLI (developer tool)
• External services: OSRM routing, IPInfo, Google Maps, Twilio/SMS, email services
b. Relationships & interactions
• Browser ↔ Console: HTTP(S) static asset requests & Ember Data REST/JSONAPI calls
• Console ↔ API: REST endpoints (CRUD) + WebSocket subscriptions via SocketCluster
• API ↔ DB/Redis: Eloquent ORM to MySQL, Cache & Pub/Sub in Redis
• API ↔ Extensions: Plugin loader calls extension APIs, dynamically registers routes/providers
• API ↔ External services: outbound HTTP to OSRM or third-party APIs, email/SMS providers
• CLI ↔ API: HTTP API calls for extension management, scaffolding
c. Architectural patterns & design principles
• Layered architecture: Presentation (Ember), Application (Laravel controllers/services), Data (ORM, cache)
• Modular & plugin-based: “packages/” enabling domain-specific engines and extensions
• API-first: All operations exposed via REST/JSONAPI and sockets
• Infrastructure as code: Docker Compose locally, Helm charts in K8s for production
d. Key technologies and frameworks
• Frontend: Ember.js, Handlebars, Ember Data, Tailwind CSS
• Backend: PHP 8, Laravel Framework, Sanctum, Artisan, Composer
• Real-time: SocketCluster
• Data: MySQL, Redis
• Infra: Docker, Docker Compose, Kubernetes (Helm), Caddy/Nginx