- What is the ShopperLabs Laravel Sail Starter Kit?
- The ShopperLabs Laravel Sail Starter Kit is a ready-to-use Laravel scaffold built around Laravel Sail and Docker. It preconfigures a local development stack with database, cache, and mail-testing services, and v1.2 adds Filament v5 and Livewire 4. It is a starter kit rather than a library: you create or clone a project, then own and modify the code. For a minimal setup, plain Laravel Sail or a lighter Breeze-based starter may be a better alternative.
- How do I install or scaffold a project with this package?
- Scaffold it with composer create-project shopperlabs/laravel-sail-starter-kit my-app, then change into the directory and start the containers with ./vendor/bin/sail up or sail up -d. If you cloned the repository instead, run a one-time Composer install and follow the README's .env setup. Once Sail is running, use it for Artisan, Composer, and test commands so everything executes inside the container. Confirm the exact commands in the repository README, since starter-kit scripts can change between releases.
- Do I need PHP, Composer, MySQL, or Node installed locally for Laravel Sail?
- For daily development, no: Docker and Sail supply PHP and the database, so you do not need local PHP, MySQL, or a local database server. You do need Docker. For the initial scaffold you need Composer or a clone plus a one-time Composer install; after that, run commands through Sail.
- Which Laravel, PHP, Filament, and Livewire versions does v1.2 require?
- The v1.2 release upgrades the kit to Filament v5 and Livewire 4, but the overview does not state exact PHP and Laravel minimum versions. Read composer.json for the platform requirements and confirm whether the upgrade raises the PHP floor above 8.2. That check matters if you are on an older runtime or a constrained CI image.
- Can I upgrade this starter kit with composer update like a normal package?
- No. A starter kit is a scaffold, not a library, so a version bump does not arrive through composer update. You either re-scaffold a fresh v1.2 project and port your application code, or manually apply the Filament v5 and Livewire 4 changes to your existing tree. Treat that as an engineering migration, not a dependency bump.
- How do I migrate an existing v1.1.x app to v1.2?
- There is no published upgrade guide in the provided context; PR #38, which upgrades Filament and Livewire, is the main artifact. The safest path is to re-scaffold v1.2 fresh and port your application code. Alternatively, hand-apply the framework upgrades to your existing project. First confirm which Filament major your v1.1.x project used, because moving from Filament v3 to v5 means crossing two majors and expecting broader admin UI changes.
- Is this starter kit a good fit for a headless API or an Inertia/Vue SPA?
- No, this is an opinionated Filament, Livewire, and Docker Compose stack. If your product is API-only or uses a separate Vue or React SPA with Inertia, the kit's admin and frontend assumptions add little value. Stay on a thinner scaffold or plain Laravel Sail instead.
- What Docker services and environment defaults come preconfigured?
- The kit includes Sail and Docker Compose defaults with services for the database, cache, and mail testing, plus .env defaults intended to get you running quickly. The goal is a reproducible local stack without installing MySQL on your host. Review docker-compose.yml and .env.example for the exact images and ports before customizing.
- Is Filament v5 and Livewire 4 safe for production, and what about plugin compatibility?
- Treat it as leading-edge: Filament v5 and Livewire 4 are new majors, and third-party Filament plugins and Livewire libraries often lag behind. Verify every plugin, field type, and dependency you rely on has a v5-compatible release before committing. Expect thinner documentation and outdated AI-assistant advice around v5 APIs, so validate upgrades in a branch.
- How should I run tests, and what are the maintenance concerns?
- Run tests inside the Sail container, for example with sail artisan test or your configured test runner, so the environment matches CI; the preconfigured database and mail services help feature tests. Maintenance-wise, the repository's recent releases are mostly Dependabot group bumps, with the Filament and Livewire upgrade as the real product change. Review lockfile diffs and composer.json constraints rather than trusting version tags alone.