PHPackages                             lanin/laravel-setup-wizard - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. lanin/laravel-setup-wizard

ActiveLibrary[Framework](/categories/framework)

lanin/laravel-setup-wizard
==========================

Provide your Laravel project with handy setup wizard

0.1.4(10y ago)1225MITPHPPHP >=5.5.9

Since Nov 29Pushed 10y ago1 watchersCompare

[ Source](https://github.com/mlanin/laravel-setup-wizard)[ Packagist](https://packagist.org/packages/lanin/laravel-setup-wizard)[ RSS](/packages/lanin-laravel-setup-wizard/feed)WikiDiscussions master Synced 4w ago

READMEChangelog (5)Dependencies (6)Versions (7)Used By (0)

Laravel-Setup-Wizard
====================

[](#laravel-setup-wizard)

[![Travis](https://camo.githubusercontent.com/93e9bdc997124001df0d8bf7f2dc91869204ec9f36382397ecdf5eddb4db9b37/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f727573742d6c616e672f727573742e737667)](https://travis-ci.org/mlanin/laravel-setup-wizard)[![Scrutinizer](https://camo.githubusercontent.com/2b5cbb56fd8d42020a93de849103e62f31649755b02c01f9e8ec5783df1731be/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6d6c616e696e2f6c61726176656c2d73657475702d77697a6172642e737667)](https://scrutinizer-ci.com/g/mlanin/laravel-setup-wizard/)[![Scrutinizer Coverage](https://camo.githubusercontent.com/81046e689a3aad669b359a071f8015084daa1ad8a114be8eaa4cf016c2ae04e2/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f636f7665726167652f672f6d6c616e696e2f6c61726176656c2d73657475702d77697a6172642e737667)](https://scrutinizer-ci.com/g/mlanin/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.

[![help](https://camo.githubusercontent.com/41024594dac691d0d260fb585cabc95c28f9d3809bbef253f268ceddfdbb313e/687474703a2f2f6c616e696e2e6d652f696d616765732f73657475702e706e67)](https://camo.githubusercontent.com/41024594dac691d0d260fb585cabc95c28f9d3809bbef253f268ceddfdbb313e/687474703a2f2f6c616e696e2e6d652f696d616765732f73657475702e706e67)

Installation
------------

[](#installation)

[PHP](https://php.net) 5.5.9+ or [HHVM](http://hhvm.com) 3.3+, [Composer](https://getcomposer.org) and [Laravel](http://laravel.com) 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
-----

[](#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 steps manually by adding it's alias as an argument:

```
$ php artisan app:setup migrate seed
```

For additional help use:

```
$ php artisan help app:setup
```

Configuration
-------------

[](#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 --tag=setup
```

Extending
---------

[](#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:

```
/**
 * 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.

```
/**
 * 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.

```
/**
 * 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.

```
/**
 * 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
------------

[](#contributing)

Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.

###  Health Score

26

—

LowBetter than 41% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~6 days

Total

5

Last Release

3842d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/968784dc2366d12ce2bd6e0b7beaa7ab3cd65ae526401f7840c057c51f5687fe?d=identicon)[lanin](/maintainers/lanin)

---

Top Contributors

[![mlanin](https://avatars.githubusercontent.com/u/467159?v=4)](https://github.com/mlanin "mlanin (3 commits)")

---

Tags

frameworklaravelinstallerwizardsetup

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/lanin-laravel-setup-wizard/health.svg)

```
[![Health](https://phpackages.com/badges/lanin-laravel-setup-wizard/health.svg)](https://phpackages.com/packages/lanin-laravel-setup-wizard)
```

###  Alternatives

[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k38.6M289](/packages/laravel-dusk)[laravel/sail

Docker files for running a basic Laravel application.

1.9k199.2M1.2k](/packages/laravel-sail)[laravel/ai

The official AI SDK for Laravel.

1.0k2.1M163](/packages/laravel-ai)[laravel/mcp

Rapidly build MCP servers for your Laravel applications.

77018.2M122](/packages/laravel-mcp)[laravel/jetstream

Tailwind scaffolding for the Laravel framework.

4.1k21.1M148](/packages/laravel-jetstream)[laravel-zero/framework

The Laravel Zero Framework.

3491.5M419](/packages/laravel-zero-framework)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)