lunarphp/lunar
Lunar
Lunar is a modular PHP e-commerce framework and headless commerce engine designed to manage the backend logic and data models of an online store. It provides a decoupled infrastructure that separates business logic from the presentation layer, allowing for the orchestration of digital storefronts via an API.
The system is distinguished by its headless-first approach and a dedicated toolkit for building customized administration interfaces using pre-made components and widgets. It supports complex global operations through a multilingual commerce system that handles regional storefront configurations, multiple currencies, and geographic shipping rules.
The framework covers a comprehensive suite of commerce capabilities, including hierarchical product cataloging with custom attribute mapping, shopping cart and checkout coordination, and event-driven order lifecycle tracking. It also incorporates identity and access management through role-based permissions and multi-factor authentication for staff, alongside logistics tools for shipping rate calculation and inventory fulfillment.
The project includes a utility to export structured technical documentation to assist large language models in understanding the project context.
Features
- Product Catalog Management - Provides a comprehensive catalog system for handling product details, pricing, images, and variants.
- E-Commerce Backends - Implements the core server-side logic and administrative panel for managing retail operations and e-commerce data.
- PHP E-commerce Frameworks - Provides a modular developer-centric framework built with PHP for creating and customizing online stores.
- System Capability Extensions - Integrates third-party add-ons through defined extension points to add new operational capabilities to the core system.
- Commerce Engines - Serves as a decoupled commerce core that manages business logic and data via an API.
- Commerce Event Orchestration - Coordinates the sequence of events across catalogs, carts, and checkout to ensure successful purchases.
- Custom Product Attributes - Supports diverse product types through flexible attribute mapping that avoids database schema modifications.
- Customer Account Management - Handles user authentication, personal account sections, and the tracking of customer order histories.
- E-commerce Integrations - Integrates payment processing, shipping cost calculations, and tax application during the checkout process.
- Regional Storefront Configurations - Allows for the configuration of multiple languages, currencies, and shipping zones based on customer location.
- Order Fulfillment - Tracks stock levels and manages the shipping and returns process for customer orders.
- Order Lifecycle Management - Coordinates the end-to-end flow of orders from initial placement through payment to final fulfillment.
- Order Management Systems - Provides a comprehensive system for tracking, managing, and fulfilling customer purchases and sales orders.
- Product Catalogs - Provides a system for organizing products into nested groups and hierarchical category structures.
- Product Catalog Management - Allows the definition of custom attributes to extend product data models beyond standard fields.
- Checkout Workflows - Implements multi-step checkout processes for address collection, shipping selection, and order creation.
- Regional Commerce Configurations - Localizes storefronts by managing currency, language, and regional shipping and tax rules based on user session.
- Regional Commerce Management - Provides tools for configuring multi-regional settings including currency, localization, and international shipping.
- Shipping Configurations - Determines delivery costs based on geographic zones, cart totals, item weights, and delivery methods.
- Shopping Carts - Provides logic for managing items, sessions, and state within a digital shopping cart.
- Store Administration Panels - Provides a secure management panel for staff to control product inventory, order fulfillment, and regional settings.
- Store Business Settings - A system for setting global parameters for sales channels, supported languages, and currencies to define shop behavior.
- Product Collection Hierarchies - Supports grouping products into categorized collections to simplify store navigation and merchandising.
- Product Discovery Systems - Provides search functionality and hierarchical navigation to help users locate specific products.
- Granular Permission Systems - Controls administrative access through a system of roles and hierarchical permissions.
- Access Control - Provides a centralized system for managing backend access using roles, permissions, and MFA for staff.
- Modular Extension Architectures - Provides defined hooks and interfaces allowing third-party add-ons to modify core system behavior.
- Headless Commerce - Decouples backend business logic from the frontend via an API-first headless commerce architecture.
- Currency Configuration - Defines monetary units and exchange rates to synchronize prices and manage decimal precision.
- Payment Gateway Integrations - Integrates with payment gateways to handle payment intents, webhooks, and the complete transaction lifecycle.
- Catalog Renderings - Provides a system for rendering product listing and display pages with variant selection and faceted filtering.
- Product Relationship Mappings - Provides a utility to define cross-sell and up-sell relationships to suggest complementary items on the storefront.
- Sales Channel Management - Provides a system to define distinct sales outlets and control product and discount visibility across multiple storefronts.
- Shipping Zone Management - Limits shipping availability to specific countries, states, or postcodes to control delivery areas.
- Product Exclusions - Prevents specific items from being shipped to designated geographic zones through exclusion lists.
- Multilingual Content Mappings - Links primary language content to translated equivalents for multilingual storefront delivery.
- Product Search Engines - Implements an indexing and retrieval system for products and store data using external search engines.
- Multi-Factor Authentication - Requires staff members to use two-factor authentication and recovery codes for secure administrative access.
- Payment Gateway Security - Delegates card data to compliant providers and verifies webhook signatures to ensure secure payment processing.
- Role-Based Access Control - Restricts administrative actions by assigning hierarchical permissions to user roles within a staff authentication guard.
- Session Isolations - Separates staff authentication from customer sessions using a dedicated security guard.
- Admin Interface Extensions - Allows customization of the administration panel through new resource pages and custom attribute fields.
- Admin Interface Components - Offers a system for assembling administrative dashboards using pre-defined widgets and resource pages.
- Admin Panel Frameworks - Provides a specialized framework for building production-ready administrative interfaces using pre-made components.
- Multi-Storefront Orchestrators - Coordinates the operation of multiple distinct storefronts from a single centralized backend instance.
- Field-Level Translation Storage - Stores model fields as translations and resolves content based on the active application locale or fallback language.
