Add handy setup wizard to your Laravel project

Imagine that you distribute your Laravel project. It is awesome, useful and remarkable. But every time your customer installs it, he has to perform a set of steps to setup it: add .env file, run migrations and seed, etc. And you have to mention them all in your README and hope that user will do everything right. But why not to guide your customer through all this steps with one simple command?

All you have to do is to add Laravel-Setup-Wizard package to your project!

setup

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.

$ composer require "lanin/laravel-setup-wizard:0.1.*"

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.

Lanin\Laravel\SetupWizard\SetupWizardServiceProvider::class,

Usage

After installation project will receive the new Artisan command:

$ php artisan app:setup

This command gives your customers the easy wizard for initial setup of the your project. By default it has 6 steps:

  1. Set new .env file from your .env.example or update existing
  2. Create new DB & user from .env
  3. Run migrations
  4. Run seeds
  5. Create first user
  6. Optimize code

Also they can run single step manually by adding it’s alias as an argument:

$ php artisan app:setup create_user

For additional help use:

$ php artisan help app:setup

Configuration

All defaults are stored in setup.php config file. You can publish it in your app’s config folder using artisan command:

$ php artisan vendor:publish

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 abstract class Lanin\Laravel\SetupWizard\Commands\Steps\AbstractStep.

It has three abstract methods that you have to create:

<?php
/**
 * Return command prompt text.
 *
 * @return string
 */
abstract public function prompt();

This method has to return prompt text that will be shown to the user before step is executed.

<?php
/**
 * Prepare step data.
 *
 * @return mixed
 */
abstract protected function prepare();

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.

<?php
/**
 * Preview results.
 *
 * @param  mixed $results
 * @return void
 */
abstract public function preview($results);

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.

<?php
/**
 * Finish step.
 *
 * @param  mixed $results
 * @return bool
 */
abstract public function finish($results);

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.

Star Fork