
Prerequisites
| Requirement | Version |
|---|---|
| PHP | 8.4+ |
| Laravel | 12.0+ |
| Shopper | 2.9+ |
| Node.js | 20+ |
Installation
Theshopper:kit:install command is built into Shopper. No additional package is required.
| Package | Version | Purpose |
|---|---|---|
inertiajs/inertia-laravel | ^3.0 | Inertia server-side adapter for Laravel |
laravel/fortify | ^1.37 | Authentication backend (login, register, 2FA) |
laravel/wayfinder | ^0.1.14 | Typed route helpers generated from your routes |
spatie/laravel-typescript-transformer | ^3.2 | Generates TypeScript types from PHP DTOs and enums |
shopper/stripe | ^2.9 | Stripe payment integration |
composer.json. The code is yours.
Project Structure
The starter kit publishes files into standard Laravel directories. The backend is shared with the Vue Starter Kit; only theresources/js frontend differs. Here is the full structure.
Routing
The starter kit defines all storefront routes inroutes/web.php. Unlike the Livewire kit, each page is rendered by a dedicated controller that returns an Inertia response. Routes are named so you can reference them through Wayfinder in your React components.
Public Routes
| Route | Controller | Description |
|---|---|---|
GET / | Shop\HomeController | Homepage with featured collections, products, and categories |
GET /shop | Shop\ProductController@index | Product catalog with search and filtering |
GET /shop/{product:slug} | Shop\ProductController@show | Product detail with variant selection |
GET /categories | Shop\CategoryController@index | All categories |
GET /categories/{category:slug} | Shop\CategoryController@show | Products in a category |
GET /collections/{collection:slug} | Shop\CollectionController@show | Products in a collection |
GET /search | Shop\SearchController | Full-text search across products |
GET /cart | Shop\CartController@index | Shopping cart |
POST /cart adds a line, PATCH /cart/{line} updates a quantity, DELETE /cart/{line} removes a line, and DELETE /cart clears the cart. The active pricing zone is changed with PATCH /zone.
Authenticated Routes
These routes require the user to be logged in and have a verified email.| Route | Controller | Description |
|---|---|---|
GET /checkout | Shop\CheckoutController@index | Multi-step checkout flow |
GET /checkout/payment/{number} | Shop\StripePaymentController | Stripe Payment Element |
GET /checkout/success/{order} | Shop\CheckoutSuccessController | Order confirmation |
GET /account/orders | Account\OrderController@index | Order history |
GET /account/orders/{order} | Account\OrderController@show | Order detail |
GET /account/addresses | Account\AddressController@index | Address management |
GET /settings/profile | Settings\ProfileController@edit | Profile settings |
GET /settings/appearance | Inertia page | Dark mode / appearance |
GET /settings/security | Settings\SecurityController@edit | Password and two-factor authentication |
checkout/shipping-address, checkout/shipping-option, checkout/prepare-payment, checkout/place-order). The Stripe webhook endpoint is registered at /webhooks/stripe with rate limiting.
Architecture
The starter kit follows a clear separation of concerns. Business logic lives in Action classes, data structures in DTOs, HTTP handling in controllers, and UI in React components. This makes it straightforward to modify any part of the storefront without affecting others.Actions
Actions are single-responsibility classes that encapsulate business logic. They are resolved from the container, so you can swap implementations or add dependencies as needed.| Action | Responsibility |
|---|---|
BuildShippingPackages | Builds package dimensions from cart items for carrier rate requests |
FetchDeliveryRates | Queries available carriers and returns shipping rate options |
FetchPaymentMethods | Loads payment methods available for the customer’s country |
ResolveZoneForCountry | Resolves the pricing zone for a given country with caching |
CreateOrder, which uses Cache::lock for idempotency and verifies cart ownership before converting the cart into an order.
DTOs
Data Transfer Objects provide type-safe structures for data passed between the backend and the React frontend. Because the kit uses the TypeScript Transformer, these DTOs also become TypeScript types your components can import.| DTO | Purpose |
|---|---|
AddressData | Structured address data for forms and checkout |
CountryByZoneData | Zone session data (zone ID, country code, currency code) |
PriceData | Formatted price with amount, currency, and comparison price |
ProductReviewsData | Aggregated review data (average rating, count, distribution) |
Controllers
Each storefront page is rendered by a controller inapp/Http/Controllers/. Controllers query Shopper’s models, wrap data in DTOs, and return an Inertia response that renders the matching page component.
resources/js/pages/.
Inertia Shared Data
TheHandleInertiaRequests middleware shares global data with every page, so your components always have access to the authenticated user and the current shop state without re-fetching it. The shop prop carries the cart count, the selected zone, the active currency, available channels and zones, the tax label, and navigation categories.
useShop hook reads this shared data, and useCart exposes the cart count and mutation helpers.
Models
The starter kit publishes model files that extend Shopper’s base models. These are configured inconfig/shopper/models.php so that Shopper’s internals use your extended versions.
InteractsWithStorefrontMedia trait appends thumbnail and images attributes to every JSON response, so your React components receive ready-to-use media URLs.
CheckoutSession
TheCheckoutSession class defines constants for session keys used throughout the checkout flow. This provides a single place to reference all checkout-related session data.
Helpers
Theapp/helpers.php file defines three global functions used across the storefront.
| Function | Purpose |
|---|---|
cartSession() | Returns the current cart or creates a new one with the active zone, currency, and channel |
current_currency() | Returns the currency code for the selected zone, or the store default from shopper_currency() |
current_tax_label() | Returns the tax label (“TTC” or “HT”) based on the zone’s tax configuration |
Type Safety
This kit is type-safe end to end. Three tools work together so your React components never guess at the shape of backend data.| Tool | What it provides |
|---|---|
| Wayfinder | Typed route helpers generated from routes/web.php, so shop.product becomes an importable function |
| TypeScript Transformer | Generates TypeScript definitions from your PHP DTOs and enums into resources/js/types |
@shopperlabs/shopper-types | Shared domain types (Address, Cart, Order, Product, and enums) published as an npm package |
TypeScriptTransformerServiceProvider registers the transformer. Run the generation command after changing a DTO to refresh the TypeScript types your components import.
Checkout Flow
The checkout is a multi-step process handled byCheckoutController. Each step posts to its own endpoint and validates its data before proceeding to the next.
Step 1 - Shipping Address. The customer enters a new address or selects one of their saved addresses. The address is stored in the session and attached to the cart via CartManager::addAddress().
Step 2 - Delivery Options. The BuildShippingPackages action builds package data from the cart, then FetchDeliveryRates queries configured carriers for available shipping rates based on the address and packages. The customer selects a delivery option.
Step 3 - Payment. FetchPaymentMethods loads available payment methods for the customer’s country. When the customer places the order, the CreateOrder action converts the cart into an order inside a database transaction, adds shipping costs, and initiates payment processing through Shopper’s PaymentProcessingService.
For Stripe payments, the customer is redirected to a dedicated payment page (StripePaymentController) that renders the Stripe Payment Element through the useStripeElements hook. The StripeWebhookController handles payment confirmation webhooks.
Zones and Currency
The starter kit uses Shopper’s zone system for multi-currency and regional pricing. TheZoneSelector component in the footer lets customers pick their country. When a zone is selected, the ZoneSessionManager stores a CountryByZoneData DTO in the session with the zone ID, country code, and currency code. All prices across the storefront update to reflect the zone’s currency through the shared shop prop.
If no zone is selected, the storefront falls back to your store’s default currency from shopper_currency().
The current_tax_label() helper checks the zone’s tax configuration to display “TTC” (tax-inclusive) or “HT” (tax-exclusive) labels alongside prices.
To enable zone selection, create at least one active zone in your Shopper admin panel. You can optionally set a default zone using the SHOPPER_DEFAULT_ZONE environment variable.
Customization
Once installed, every file belongs to your project. Here are the most common customization paths.Styling
All views use shadcn/ui components and Tailwind CSS v4. Modify colors, spacing, and layouts by editing the components inresources/js. UI primitives live in resources/js/components/ui/, and the storefront chrome is in resources/js/layouts/storefront/.
Pages
Each page is a React component inresources/js/pages/. Edit any .tsx file to change a page’s layout or content. To change the data a page receives, edit its controller in app/Http/Controllers/.
Checkout
To modify the checkout flow, edit the action classes inapp/Actions/Checkout/. Each action handles one concern, so you can change how shipping rates are calculated without touching payment logic.
To add a new payment provider, implement the provider using Shopper’s payment system and register it in your admin panel. The checkout will automatically pick it up through FetchPaymentMethods.
Adding Pages
Create a controller, register a named route inroutes/web.php, and add the matching React component under resources/js/pages/.
Models
Add methods, scopes, or relationships directly to the model files inapp/Models/. These models extend Shopper’s base models, so all existing functionality is preserved.