README

为您的 Laravel 项目提供便捷的设置向导。

引导客户完成所有必要的步骤以正确设置您的项目。

安装

需要 PHP 5.5.9+ 或 HHVM 3.3+，Composer 和 Laravel 5.1+。

要获取 Laravel-Setup-Wizard 的最新版本，只需通过 Composer 安装即可。

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

安装 Laravel-Setup-Wizard 后，您需要注册服务提供者。打开 config/app.php 并将以下内容添加到 providers 键中。

Lanin\Laravel\SetupWizard\SetupWizardServiceProvider::class,

使用

安装后，项目将获得新的 Artisan 命令

$ php artisan app:setup

此命令为您的客户提供项目初始设置的简单向导。默认情况下，它有 6 个步骤

1. 从 .env.example 设置新的 .env 文件或更新现有的
2. 从 .env 创建新的数据库和用户
3. 运行迁移
4. 运行种子
5. 创建第一个用户
6. 优化代码

他们也可以通过添加别名作为参数手动运行步骤

$ php artisan app:setup migrate seed

如需更多帮助，请使用

$ php artisan help app:setup

配置

所有默认值都存储在 setup.php 配置文件中。您可以使用 artisan 命令将其发布到您的应用 config 文件夹中

$ php artisan vendor:publish --tag=setup

扩展

您可以在 setup.php 配置中指定自己的安装步骤。

首先，您应该创建一个新的步骤类，该类将扩展 Lanin\Laravel\SetupWizard\Commands\Steps\AbstractStep。它有三个抽象方法，您必须创建它们

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

此方法必须返回在执行步骤之前显示给用户的提示文本。

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

此方法可用于收集步骤执行所需的所有数据。例如，要求用户提供额外的数据或凭据等。所有这些数据都应返回以供进一步执行。

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

预览方法用于显示用户关于将要执行特定命令的信息。它用于确保一切顺利。

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

最后一个但也是最重要的步骤是步骤执行。如果一切顺利，则返回布尔值 true；如果有错误，则返回 false。

完成所有操作后，将您的步骤添加到 setup.php 文件中的 setup.steps 数组中，其中键是步骤的别名，值是完全解析的类名。

贡献

请随意分支此包，并通过提交拉取请求来增强功能以进行贡献。