User Guide
Overview
Local Laravel brings first-class Laravel development to Local (by Flywheel). Create, develop, and manage Laravel applications with the same ease as WordPress sites, using Local’s bundled PHP, MySQL, and Nginx infrastructure.
Installation
Method 1: Pre-built Release (Recommended)
The easiest way to install the addon.
- Go to the Releases page
- Download the
.tgzfile from the latest release (e.g.,local-addon-laravel-0.0.1.tgz) - Open Local
- Go to Add-ons (in the left sidebar)
- Click Install from disk (top right)
- Select the
.tgzfile you downloaded - Toggle the addon ON to enable
- Click Relaunch when prompted
Method 2: Build from Source
For developers or contributors:
git clone https://github.com/jpollock/local-addon-laravel.git
cd local-addon-laravel
npm install
npm run build
npm run install-addon
# Restart Local, then enable the addon
Uninstallation
If installed from disk (Method 1)
- Open Local
- Go to Add-ons (in the left sidebar)
- Find Local Laravel
- Toggle it OFF
- Click the trash icon or Remove button
- Restart Local
If installed via npm script (Method 2)
cd local-addon-laravel
npm run uninstall-addon
Then restart Local.
Creating a Laravel Site
- Click + Create a new site in Local
- Select Laravel Project from the site type options
- Enter your site name and domain
- Choose your PHP version (8.2+ required) and Laravel configuration
- Click Create Site
Local Laravel will automatically:
- Create a new Laravel project using Composer
- Configure your
.envfile with Local’s database credentials - Run initial migrations
- Set up Nginx with Laravel-optimized configuration
Using the Laravel Panel
Once your Laravel site is running, access the Laravel-specific features:
- Open your Laravel site in Local
- Go to the Laravel tab in the site info panel
- Use the quick command buttons or enter custom Artisan commands
- View output directly in Local
Quick Commands
| Command | Description |
|---|---|
migrate |
Run database migrations |
migrate:fresh --seed |
Fresh migration with seeders |
cache:clear |
Clear application cache |
route:list |
List all registered routes |
make:model |
Create a new Eloquent model |
make:controller |
Create a new controller |
Custom Artisan Commands
Enter any valid Artisan command in the text field and click Run. Output appears in the panel below.
Configuration
Laravel Versions
Local Laravel supports:
- Laravel 11.x (default) - requires PHP 8.2+
- Laravel 10.x - requires PHP 8.1+
Starter Kits
When creating a new site, you can optionally include:
| Kit | Description |
|---|---|
| None | Vanilla Laravel installation |
| Laravel Breeze | Simple authentication scaffolding with Blade/Tailwind |
More starter kits (Jetstream, Filament) coming in future releases.
Site Directory Structure
Your Laravel app lives in the standard Local site structure:
~/Local Sites/your-site/
├── app/
│ ├── public/ # Laravel's public directory (web root)
│ ├── app/ # Application code
│ ├── config/ # Configuration files
│ ├── database/ # Migrations, seeders, factories
│ ├── resources/ # Views, assets
│ ├── routes/ # Route definitions
│ ├── storage/ # Logs, cache, sessions
│ ├── tests/ # Test files
│ ├── .env # Environment configuration
│ ├── artisan # Artisan CLI
│ └── composer.json # Dependencies
├── conf/ # Local's service configs
└── logs/ # Service logs
FAQ
Q: What PHP version do I need?
A: Laravel 11 requires PHP 8.2 or higher. Laravel 10 requires PHP 8.1+. Select the appropriate PHP version in Local’s site configuration.
Q: Can I use existing Laravel projects?
A: Currently, Local Laravel is designed for creating new Laravel projects. Support for importing existing projects is planned for a future release.
Q: Where are my Laravel logs?
A: Laravel’s application logs are in ~/Local Sites/your-site/app/storage/logs/laravel.log.
Q: How do I run npm commands for my frontend?
A: Use Local’s “Open Site Shell” feature to get a terminal in your site directory, then run npm install, npm run dev, etc.
Support
- Report bugs: GitHub Issues
- Feature requests: GitHub Discussions
- Questions: GitHub Discussions