How shopperlabs/shopper works
Project type and purpose
• This is a Laravel-based, headless e-commerce admin panel framework (“Shopper Framework”) distributed as a monorepo.
• It exposes an admin UI (Blade + Livewire), core domain logic (Eloquent models, repositories, events), and a sidebar component as separate Composer packages.
File structure
• Top-level “packages” directory with three Composer packages:
• packages/admin – the admin UI (controllers, Livewire components, assets, views, routes)
• packages/core – the domain layer (models, migrations, repositories, events, console commands)
• packages/sidebar – a sidebar/menu builder library used by the admin UI
• Root has build tooling (package.json & pnpm scripts for JS/CSS assets, monorepo-builder.php), CI workflows (.github/workflows), and standard Laravel config (artisan, composer.json, phpunit.xml).
README insights
• Shopper Framework is for managing catalog, orders, discounts, customers, reviews, currencies, zones.
• Built on Laravel 11.x, uses Tailwind, Livewire, FilamentPHP, Wire Elements.
• Encourages extensibility (config files, stubs, contracts).
Main components and relationships
a. Frontend (Admin UI)
• Browser clients interact via HTTP(S), sending requests to Laravel routes defined in packages/admin/routes/*.php
• UI layer comprised of Blade templates, Livewire components (server-driven), and bundled JS/CSS assets (pnpm build outputs shopper.js/shopper.css)
• Sidebar builder (packages/sidebar) renders navigation dynamically via middleware ResolveSidebars and Blade view composers
b. Backend (Laravel app)
• HTTP Kernel and middleware stack (packages/admin/src/Http/Middleware + core middleware)
• Controllers (AssetController, Auth controllers) and Livewire endpoints dispatch actions
• Actions & Jobs (packages/admin/src/Actions + Jobs) implement business workflows (e.g., CreateProductAction, AttachDiscountToCustomers job)
c. Domain & Data (Core Package)
• Eloquent Models (packages/core/src/Models) represent Customers, Orders, Products, etc.
• Migrations & Seeders under packages/core/database set up schema & initial data
• Repositories & Contracts implement data access and domain logic (packages/core/src/Repositories + Contracts)
• Events & Listeners propagate domain events (OrderCreated → listeners, attached via Laravel’s event system)
d. Infrastructure services
• Database (MySQL/PostgreSQL): stores domain data
• Cache / Queue (Redis): optional for event-driven jobs (discount attachments, notifications)
• Mail (SMTP / third-party): sending credentials, order notifications
• File storage (local/S3): product images, user avatars
Architectural patterns & design principles
• Monorepo modularization: clear separation of UI (admin), domain (core), and cross-cutting library (sidebar)
• MVC + Livewire (server-driven components)
• Action classes (Single Responsibility) for core use cases
• Repository pattern encapsulating data access
• Event-driven architecture for side effects (Jobs and Listeners)
• Contract-based extensibility (interfaces under src/Contracts)