Skip to content

Requirements

Server and package requirements for running Shopper.

Shopper is a Laravel package and shares the same server requirements as Laravel itself, plus the PHP extensions listed below.

Server Requirements

  • PHP 8.3+ (the test suite runs on PHP 8.3, 8.4 and 8.5)
  • MySQL 8+, PostgreSQL 15+ or SQLite

The test suite runs on these three databases. MariaDB is not part of it.

PHP Extensions

Shopper requires these extensions on top of the ones Laravel needs. Composer refuses to install Shopper if one of them is missing:

ExtensionPurpose
intlCurrency formatting, locale support, and internationalization
gdRequired by milon/barcode, which draws the barcode on the variant page. GD is also the default image driver of Spatie Media Library, which builds the resized copies (the large and medium conversions) of product, variant, category, brand, and collection images
exifRequired by Spatie Media Library, which reads the metadata of uploaded images
zip, xmlreaderRequired by OpenSpout, the spreadsheet library of Filament's actions package
iconvRequired by bacon/bacon-qr-code, which draws the QR code a user scans to set up two-factor authentication
soapRequired by ivanmitrikeski/laravel-shipping, the carrier library behind shopper/shipping. Composer refuses to install Shopper without it, even if your store uses no carrier.

Laravel Herd includes all of these extensions. On Linux servers and in the official php Docker images, intl, gd, zip and soap usually have to be installed separately (for example the php8.3-intl and php8.3-soap packages on Ubuntu). Run php -m to list the extensions your PHP has.

GD stays required even if you prefer ImageMagick, because milon/barcode needs it. To build the image conversions with ImageMagick, install the imagick extension and set IMAGE_DRIVER=imagick in your .env file. Spatie Media Library reads this variable for its image_driver option.

Package Requirements

PackageVersion
Laravel11.28+ / 12.x / 13.x
Filament4.12+ (not 5.x)
Livewire3.8+ (not 4.x)

Composer installs Filament and Livewire as dependencies of Shopper, so you do not require them in your application. Shopper 2 stays on Filament 4, which runs on Livewire 3. The Laravel 11.28 minimum is also Filament 4's minimum. A new Laravel major version needs a Shopper release that adds it, even when Filament already supports it.

Development Environments

Laravel Herd

Laravel Herd is the recommended development environment for both macOS and Windows. It provides PHP and Nginx with zero configuration, and SQLite works out of the box. MySQL and PostgreSQL run as services in Herd Pro. Herd's PHP builds include all the extensions listed above.

Laravel Valet

Laravel Valet is a lightweight development environment for macOS. It maps all subdirectories in a directory (such as ~/Sites) to .test domains. You can share your sites publicly using local tunnels.

Docker

Any Docker setup that satisfies the PHP and database requirements will work. The Shopper demo store uses Docker with FrankenPHP (Laravel Octane) as a reference.

Last updated on

Edit on GitHub