在您使用 Laravel Orchid 之前，您需要先安装它。本指南将帮助您进行简单的安装以启动项目。

创建一个新的 Laravel 项目

注意。 如果您已经安装了 Laravel，可以跳过此步骤。

作为框架的一个包，您必须首先安装 Laravel。可以通过在终端中运行 composer create-project 命令来使用 Composer 依赖管理工具进行安装：

composer create-project laravel/laravel orchid-project "12.*"

或者，如果您更喜欢使用 Laravel Installer：

composer global require laravel/installer

laravel new orchid-project

有关如何安装 Laravel 的更多信息，请参阅 官方 Laravel 安装指南。

还没有 Composer？ 按照 下载页面 上的说明很容易安装。

这将创建一个新的 orchid-project 目录，加载依赖项，并生成启动所需的主要目录和文件。换句话说，安装您的新框架项目。

不要忘记

• 设置 storage 和 bootstrap/cache 目录的 “chmod -R o+w” 权限
• 编辑 .env 文件

注意。 如果您刚刚安装了 Laravel，可能需要使用命令 php artisan key:generate 生成一个密钥。

添加依赖

进入创建的项目目录并运行命令：

composer require orchid/platform

注意。 您还需要创建一个新的数据库，使用凭据更新 .env 文件，并将应用程序的 URL 添加到变量 APP_URL。

包安装

注意： 在安装过程中，包将覆盖 app/Models/User 模型。然而，重要的是要注意，替换模型并不是强制性的。您可以根据自己的喜好自定义模型。包会自动将某些配置（如 hidden 和 casts）应用于 Eloquent 模型。

通过运行以下命令来执行安装过程：

php artisan orchid:install

创建管理员用户

要创建具有最大权限的用户，您可以使用用户名、电子邮件和密码运行以下命令：

php artisan orchid:admin

启动开发服务器

如果您尚未安装服务器（如 Nginx、Apache 等）来运行项目，可以使用内置服务器：

php artisan serve

打开浏览器并访问 http://localhost:8000/admin。如果一切正常，您将看到控制面板的登录页面。稍后，您可以通过在终端中按 Ctrl + C 停止服务器。

注意。 假设您的运行环境使用不同的域名（例如 orchid.loc）。在这种情况下，管理面板可能不可用。您需要在配置文件 config/platform.php 或 .env 文件中指定您的域名。这样可以让管理面板在其他域名或子域名（如 platform.example.com）上可用。

更新

在项目目录中，使用 Composer 更新包：

composer update orchid/platform --with-dependencies

注意。 您也可以通过运行 composer update 更新 composer.json 文件中列出的所有依赖项。

更新到新版本后，您应确保使用 orchid:publish 更新 JavaScript 和 CSS 资产，并使用 view:clear 清除任何缓存的视图。这将确保新更新的版本使用最新版本。

php artisan orchid:publish
php artisan view:clear

保持资产更新

为了确保每当下载新版本时您的资产都能及时更新，您可以轻松地在项目的 composer.json 文件中添加一个 Composer 钩子。这将自动为您发布最新的资产：

{
    "scripts": {
        "post-update-cmd": [
            "@php artisan orchid:publish --ansi"
        ]
    }
}

添加此钩子后，您可以放心，您的资产将始终是最新的并正常运行。如果您想验证资产是否确实是最新的，可以简单地使用 artisan 控制台命令进行检查：

php artisan about

此命令将为您提供重要的信息，包括有关包本身的一些详细信息。确保您的环境配置正确并按预期运行。

安装过程中遇到问题？ 可能已经有人遇到过这个问题 https://github.com/orchidsoftware/platform/issues。如果没有，您可以发送消息或请求 帮助。

接下来做什么？

新安装的包已经有几个屏幕，展示了各种输入字段、掩码、状态以及一些界面布局。您可以尝试它们，或者直接查看“快速开始”页面上的逐步示例，或阅读文档。