iamnitinviras/laravel-installer

Laravel web installer


License
MIT

Documentation

Laravel Web Installer | A Web Installer Package

Total Downloads Latest Stable Version License

About

Do you want your clients to be able to install a Laravel project just like they do with WordPress or any other CMS? This Laravel package allows users who don't use Composer, SSH etc to install your application just by following the setup wizard. The current features are :

  • Check For Server Requirements.
  • Check For Folders Permissions.
  • Ability to set database information.
    • .env text editor
    • .env form wizard
  • Migrate The Database.
  • Seed The Tables.

Requirements

Installation

  1. From your projects root folder in terminal run:
    composer require iamnitinviras/laravel-installer
  1. Register the package
  • Laravel 11.x Register the package with laravel in bootstrap/providers.php add the following:
	IamNitinViras\LaravelInstaller\Providers\LaravelInstallerServiceProvider::class
  1. Publish the packages views, config file, assets, and language files by running the following from your projects root folder:
    php artisan vendor:publish --tag=laravelinstaller

Routes

  • /install
  • /update

Usage

  • Install Routes Notes

    • In order to install your application, go to the /install route and follow the instructions.
    • Once the installation has ran the empty file installed will be placed into the /storage directory. If this file is present the route /install will abort to the 404 page.
  • Update Route Notes

    • In order to update your application, go to the /update route and follow the instructions.
    • The /update routes countes how many migration files exist in the /database/migrations folder and compares that count against the migrations table. If the files count is greater then the /update route will render, otherwise, the page will abort to the 404 page.
  • Additional Files and folders published to your project :

File File Information
config/installer.php In here you can set the requirements along with the folders permissions for your application to run, by default the array contains the default requirements for a basic Laravel app.
public/installer/assets This folder contains a css folder and inside of it you will find a main.css file, this file is responsible for the styling of your installer, you can override the default styling and add your own.
resources/views/vendor/installer This folder contains the HTML code for your installer, it is 100% customizable, give it a look and see how nice/clean it is.
resources/lang/en/installer_messages.php This file holds all the messages/text, currently only English is available, if your application is in another language, you can copy/past it in your language folder and modify it the way you want.

Contributing

Help

License

Laravel Web Installer is licensed under the MIT license. Enjoy!