README

A Livewire admin for the artisanpack-ui/ecommerce engine, built on artisanpack-ui/livewire-ui-components. It covers orders, reviews, products, categories, tags, inventory, digital files, license keys, customers, promotions and coupons, shipping, tax, reports, notification templates, webhooks, order statuses, kanban boards, and store settings. It renders inside the cms-framework admin when that package is installed, and as a standalone admin otherwise. Every screen and action checks the engine's abilities, and other packages extend it through registries and filters.

Screenshots

Requirements

PHP 8.3+ with bcmath
Laravel 12 or 13
Livewire 3.6+ or 4
artisanpack-ui/ecommerce 1.0
artisanpack-ui/livewire-ui-components 2.1
Tailwind CSS 4 and daisyUI 5 (~5.0) in your application's Vite build

Optional: artisanpack-ui/cms-framework, artisanpack-ui/media-library, artisanpack-ui/icons, artisanpack-ui/accessibility, artisanpack-ui/ecommerce-kanban-livewire, phpoffice/phpspreadsheet (XLSX export), barryvdh/laravel-dompdf (PDF export). See Requirements.

Installation

composer require artisanpack-ui/ecommerce-admin-livewire
php artisan ecommerce-admin:install

The install command publishes config/artisanpack/ecommerce-admin-livewire.php, prints the front-end steps, and, with cms-framework, registers RBAC permissions and a shop-manager role.

Quick start

Grant access. The engine denies every ability by default, so every screen returns 403 until you grant access. In a service provider's boot():
```
Gate::define( 'ecommerce.admin', fn ( $user ) => $user->is_admin );
```
Or define individual ecommerce.{resource}.{action} abilities, or assign the shop-manager role with cms-framework. See Authorization.
Open the admin at /ecommerce-admin (the admin.route_prefix config key).
Optionally seed a demo store on a development database:
```
php artisan ecommerce:seed-demo
```

Add your 2FA middleware to admin.middleware. Neither the engine nor the admin applies it.

Front-end setup

The package ships no CSS or JavaScript build. In your application:

Add the @source lines the install command prints to your Tailwind entry:

@source "../../vendor/artisanpack-ui/ecommerce-admin-livewire/resources/views/**/*.blade.php";
@source "../../vendor/artisanpack-ui/ecommerce-admin-livewire/src/**/*.php";

Install and import the scripts the components need:
```
npm install @artisanpack-ui/livewire-drag-and-drop apexcharts flatpickr
```
Import @artisanpack-ui/livewire-drag-and-drop, set window.ApexCharts and window.flatpickr, and import the component library's sparkline.js and tinymce-editor.js.
Publish TinyMCE for the description editor with php artisan vendor:publish --tag=artisanpack-assets and load /vendor/artisanpack-ui/js/tinymce/tinymce.min.js.
Pin daisyui to ~5.0. Later releases leave the component library's tab panels empty (livewire-ui-components#119).

The layout loads your resources/css/app.css and resources/js/app.js. See Front-End Setup for the full steps and a working reference.

Documentation

Documentation home
Quick start guide
Installation: requirements, configuration, front-end setup, layouts
Usage: screens, dashboard, command palette, real-time updates, product CSV
Authorization
Extending and the hooks reference
Accessibility and localization
Advanced: Artisan commands, browser tests
FAQ and troubleshooting

Contributing

As an open source project, this package is open to contributions from anyone. Please read through the contributing guidelines to learn more about how you can contribute to this project.

composer test           # unit and feature tests
composer lint           # php-cs-fixer (dry run) and phpcs
composer test:browser   # browser suite; see docs/advanced/browser-tests.md
composer ecommerce:verify-satellite  # the engine's satellite contract verification

License

The MIT License. See LICENSE for details.

artisanpack-ui / ecommerce-admin-livewire

Package info

Security

Statistics