README

Laravel Installer - Welcome Package

This package adds a customizable welcome step to Laravel Installer with your branding and messaging.

To learn all about it, head over to the extensive documentation.

Here's what you can do:

// Set your app name and logo
APP_NAME="Your Application"
APP_LOGO=images/logo.svg

Customize welcome features:

'features' => [
    'Quick and easy installation process',
    'Automatic database configuration',
    'Built-in requirements checker',
    'Secure admin account setup',
],

Show requirements before installation:

'show_requirements' => true,
'requirements' => [
    'PHP 8.2 or higher installed',
    'Database server ready (MySQL/PostgreSQL)',
    'Write permissions on storage and bootstrap/cache',
],

The welcome step displays your app name, logo, features list, and requirements checklist—all fully customizable via config or translations.

Installation

You can install the package via composer:

composer require olakunlevpn/laravel-installer-welcome

Add the step to your installer configuration in config/installer.php:

'steps' => [
    \Olakunlevpn\InstallerWelcome\Steps\WelcomeStep::class,
    \Olakunlevpn\Installer\Steps\RequirementsStep::class,
    // ... other steps
],

Publish the configuration (optional):

php artisan vendor:publish --tag=laravel-installer-welcome-config

You can find the full installation instructions in our documentation.

Usage

Add your logo to public/images/logo.svg and configure:

APP_NAME="My Application"
APP_LOGO=images/logo.svg
WELCOME_STEP_POSITION=1

That's it! The welcome step will appear with your branding.

Customization

Publish translations to customize text:

php artisan vendor:publish --tag=laravel-installer-welcome-translations

Publish views to customize layout:

php artisan vendor:publish --tag=laravel-installer-welcome-views

Learn more about customization in the documentation.

Changelog

Please see the main CHANGELOG for more information on what has changed recently.

License

The MIT License (MIT). Please see License File for more information.

olakunlevpn / laravel-installer-welcome

Maintainers

Details