Quick Start

This guide walks you through a complete installation in about two minutes.

#Before you start

Make sure you've installed the package and built your assets.

Your .env file should be empty or missing - the installer creates it for you.

#Start your server

php artisan serve

Visit http://localhost:8000/install in your browser.

#Step 1: Welcome

The welcome screen shows your app name and installer version. Click "Get Started" or "Next" to continue.

#Step 2: Requirements

The installer checks:

PHP version (8.2+)
Required PHP extensions (PDO, mbstring, etc.)
File permissions (storage/, bootstrap/cache/)

Green checkmarks mean you're good. Red X's show what needs fixing.

**If you see errors:**

Missing extensions? Install them via your PHP manager.

Permission issues? Run:

chmod -R 775 storage bootstrap/cache

#Step 3: Permissions

Double-checks folder permissions for:

storage/framework/
storage/logs/
bootstrap/cache/

Everything should be writable (775 or 777).

#Step 4: Environment

Configure your database connection:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database
DB_USERNAME=your_username
DB_PASSWORD=your_password

The installer validates your connection before proceeding. If it fails, you'll see an error with details.

**Also configured here:**

App name
App URL
App environment (local, production)
Debug mode

#Step 5: Installing

The installer runs:

Creates/updates .env file
Generates app key
Runs database migrations
Executes plugin-specific setup (if any)
Clears caches

You'll see progress messages as each task completes.

#Step 6: Completed

Success! The installer shows:

Installation summary
Quick links to your app
Next steps recommendations

Click "Launch Application" to visit your app's dashboard.

#What happens next?

The installer creates a marker file (storage/installed) to prevent re-running. If you need to reinstall, delete this file.

Your .env is now fully configured and your database is migrated. Your app is ready to use.

#Plugin steps

If you've installed plugins (license verification, account setup), they'll appear between the core steps. The installation flow expands automatically.

Example with plugins:

Welcome
License Verification ← Plugin step
Account Setup ← Plugin step
Requirements
Permissions
Environment
Installing
Completed

Each plugin step stores its data in session until the Installing step, then saves everything to the database.

#Troubleshooting

**Stuck on a step?**

Check your browser console for JavaScript errors and Laravel logs in storage/logs/laravel.log.

**Database connection fails?**

Verify your credentials. Create the database first - the installer doesn't create databases, only tables.

**Requirements not passing?**

Install missing PHP extensions or fix file permissions as indicated.

#Next steps

Customize the installer: Customization guide
Create custom steps: Plugin creation guide
Use components: Components documentation