README

A simple UI installation setup for your Laravel Application - Heavily inspired from LinkAce

I haven't done alone this packagae on my own. I have just separated the installation setup from LinkAce package for my personal projects. The full credibility goes to LinkAce alone.

If you like this package give stars to LinkAce.

Installation

You can install the package via composer:

composer require lianmaymesi/lara-installer

You can publish the config file with:

php artisan vendor:publish --provider="Lianmaymesi\LaraInstaller\LaraInstallerServiceProvider" --tag="lara-installer-config"

Optionally, you can publish the views using

php artisan vendor:publish --provider="Lianmaymesi\LaraInstaller\LaraInstallerServiceProvider" --tag="lara-installer-views"

Usage

You have to add the middleware into your routes to redirect all routes to installations. If you have installed & created user, the middleware allows to enter your application route.

Route::middleware(['web', 'check-install'])->group(function () {
    // Your routes
});

Config

PHP Version

You have to enter the PHP Version ID that your application requies in the following format 8.0.12 => 8 * 10000 + 0 * 100 + 12

return [
    'php_version_id' => env('LI_PHP_VERSION_ID', 80012)
]

Application Version

Enter your application version for showing in the installation page

return [
    'app_version' => env('LI_APP_VERSION', '1.0.0'),
]

Redirection after Installation

Once your application installed successfully, where the user heading to

return [
    'redirect_to' => env('LI_REDIRECT_TO', 'home')
]

Marketing Headings & Tags

You can customize data in the frontend, if you'd like to keep the default UI without publishing vendor view files,

return [
    'heading' => env('LI_MARKETING_HEADING', 'Laravel installer for your App'),

    'sub_heading' => env('LI_MARKETING_SUB_HEADING', 'A simple UI installation setup for your Laravel Application - Heavily inspired from LinkAce'),

    'cta' => env('LI_MARKETING_CTA', 'https://github.com/lianmaymesi/lara-installer')
]

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

lianmaymesi / lara-installer

Maintainers

Details