How cmabris/framework works
Project type and purpose
• This code base is a Laravel-based e-commerce framework package (“AvoRed Framework”) that provides core ecommerce functionality (catalog, cart, orders, CMS, user/role management) to Laravel applications.
• It exposes both a server-rendered admin UI (Blade + Vue components + assets) and a GraphQL API layer, and plugs into Laravel via service providers.
File structure
• Top-level:
• assets/ and resources/ for frontend UI (Vue components under resources/components, Blade under resources/views, CSS/LESS/SASS under resources/)
• src/ for core PHP application code, subdivided by domain (Catalog, Cms, Order, System, User, Database, GraphQL, Support, Modules, etc.)
• config/, database/ for configuration and migrations/factories
• routes/web.php defines HTTP routes
• composer.json, service providers register the package with Laravel
• Key patterns:
• MVC: Controllers (src/**/Controllers), Requests (validation), ViewComposers
• Repository pattern: Contracts + Repository implementations under src/Database
• Service providers wire up facades, middleware, GraphQL, modules
• GraphQL subsystem with Mutations, Queries, Types
• Modular architecture: Modules/Console commands and ModuleManager
Extract insights from the README
• Highlights that this is a composer-installable Laravel package.
• Admin UI is published via vendor:publish, migrations installed, artisan commands for setup (avored:install, avored:admin:make).
Main components
a. Frontend Admin UI
• Browser → loads admin interface
• Assets delivered (CSS/JS under assets/ and compiled via Laravel Mix in resources/)
• Vue components interact via AJAX/GraphQL or submit to HTTP endpoints
b. HTTP Application Layer (Laravel)
• routes/web.php → Laravel Router
• Middleware (src/Support/Middleware/AdminAuth, RedirectIfAdminAuth)
• Controllers (src/*/Controllers) handle HTTP form submissions and return Blade views
• Requests (validation)
• ViewComposers assemble layout data
c. GraphQL API Layer
• Single GraphQL endpoint handled by GraphqlProvider
• Mutations and Queries: authentication, CRUD for catalog, system layout queries, etc.
• Type system defines DTOs
d. Domain Services and Managers
• Cart Manager, Breadcrumb Builder, Permission Manager, Module Manager
• Factories, Builders, Facades in src/Support
e. Data Access
• Repository layer (src/Database/Repository) implements Contracts (src/Database/Contracts)
• Eloquent Models (src/Database/Models)
• Database: migrations and seeders
f. External Integrations
• Laravel core services, third-party packages loaded by composer
• Artisan console commands for installation and module management
Relationships and interactions
• Browser ↔ HTTP Layer: requests for pages, forms, assets
• HTTP Layer → Domain Services → Repository → Database
• Browser ↔ GraphQL Layer: AJAX queries/mutations
• Service Providers bootstrapping components into Laravel container
• Modules Manager dynamically registers modules/providers
Architectural patterns and principles
• MVC for admin UI
• Repository + Contract to decouple models from persistence
• Service Provider pattern to register and configure subsystems (GraphQL, Menu, Cart)
• Facade pattern for global static-style access to services (Cart, Menu, Breadcrumb, Module, Permission)
• Modular plugin architecture under src/Modules
Technologies and frameworks
• Laravel 5.8 (Router, ServiceContainer, Eloquent, Middleware, Blade)
• Vue.js components for dynamic form pages
• Laravel Mix for asset compilation (LESS/SASS)
• GraphQL (webonyx/graphql-php or similar)
• PHPUnit for tests
• Composer for package management
Final advice
• Be precise: represent each subsystem (GraphQL vs MVC) and every major package (Cart, Breadcrumb, Modules).
• Service providers as the glue that binds everything into Laravel’s DI container.