Download the PHP package lanin/laravel-setup-wizard without Composer
On this page you can find all versions of the php package lanin/laravel-setup-wizard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-setup-wizard
Laravel-Setup-Wizard
Provide your Laravel project with handy setup wizard.
Guide your customer through all steps he need to perform for a proper setup of your project.
Installation
PHP 5.5.9+ or HHVM 3.3+, Composer and Laravel 5.1+ are required.
To get the latest version of Laravel-Setup-Wizard, simply install it via composer.
Once Laravel-Setup-Wizard is installed, you need to register the service provider. Open up config/app.php
and add the following to the providers key.
Usage
After installation project will receive the new Artisan command:
This command gives your customers the easy wizard for initial setup of the your project. By default it has 6 steps:
- Set new
.env
file from your.env.example
or update existing - Create new DB & user from
.env
- Run migrations
- Run seeds
- Create first user
- Optimize code
Also they can run steps manually by adding it's alias as an argument:
For additional help use:
Configuration
All defaults are stored in setup.php
config file. You can publish it in your app's config
folder using artisan command:
Extending
You can create your own installations steps specifying them in your setup.php
config.
First you should create new step class that will extend Lanin\Laravel\SetupWizard\Commands\Steps\AbstractStep
.
It has three abstract methods that you have to create:
This method has to return prompt text that will be shown to the user before step is executed.
This method can be used to collect all needed data for the step to execute. For example ask user for extra data or credentials, etc. All this data should be returned for further execution.
Preview method used to show user info about what particular commands will be executed. It is used to make user sure that everything will be ok.
The last but the most important step is right for the step execution. Should return boolean true if everything was ok and false if there was an error.
After everything is done, add your step to the setup.steps
array in your setup.php
file where key should be a step's alias and value is a fully resolved class name.
Contributing
Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.
All versions of laravel-setup-wizard with dependencies
illuminate/support Version ~5.1
illuminate/console Version ~5.1
vlucas/phpdotenv Version ~1.0