bitsoftsol/laravel-administration

Laravel 管理器可以在开发者在创建模型并使用 LaravelAdmin 或 LaravelAdminAPI 特性时自动构建 Web 和 API 的 CRUD(创建、读取、更新、删除)。开发者还可以使用 Laravel 管理器界面来构建模型和架构。

1.0.7 2023-10-25 12:58 UTC

This package is auto-updated.

Last update: 2024-09-26 09:24:39 UTC


README

Laravel Logo Total Downloads Latest Stable Version License

关于 Laravel 管理器

Laravel 管理器是一个强大的包,旨在通过自动化常见的 CRUD(创建、读取、更新、删除)操作来简化 Laravel 应用程序的开发。使用此包,您可以轻松创建模型,并享受自动生成路由、视图和控制逻辑。

功能

  • 自动 CRUD 操作。
  • RESTful API 生成。
  • 易于使用的架构构建器,用于高级自定义。
  • 用户身份验证和角色管理。
  • MIT 许可的开源软件。

安装指南

要开始使用 Laravel 管理器,请按照以下步骤操作

  1. 创建 Laravel 项目:

    composer create-project laravel/laravel LaravelAdministration
    
  2. 安装 LaravelAdministration 包:

    使用 Composer 安装 LaravelAdministration 包

    composer require bitsoftsol/laravel-administration
    
  3. 添加 LaravelAdminServiceProvider:

    打开 config/app.php 文件,并将 LaravelAdministration 服务提供者添加到 providers 数组中

    'providers' => [
        // ...
        Bitsoftsol\LaravelAdministration\LaravelAdminServiceProvider::class,
    ],
  4. 发布供应商文件:

    运行以下 Artisan 命令来发布供应商文件:当提示时,选择 LaravelAdminServiceProvider

    php artisan vendor:publish
    
  5. 安装前端资产:

    运行以下命令来构建资产

    npm install
    npm run dev
    
  6. 设置数据库连接:

    通过在您的 .env 文件中设置数据库名称来配置您的数据库连接。

  7. 运行迁移:

    执行数据库迁移和数据填充

    php artisan migrate --seed
    
  8. 启用身份验证路由:

    在您的 routes/web.php 文件中添加以下行

    Auth::routes();
  9. 提供您的项目:

    提供您的 Laravel 项目

    php artisan serve
    
  10. 访问 Laravel 管理器:

    打开您的浏览器并访问 URL (host)/admin(例如,http://127.0.0.1:8000/admin)。

  11. 登录凭证:

    使用以下凭证登录

  12. 创建超级用户:

    要为您的 Laravel 应用程序创建超级用户,请按照以下步骤操作

    • 打开您的终端并导航到您的 Laravel 项目的根目录。

    • 运行以下命令

    php artisan createsuperuser
    

createsuperuser 命令将提示您提供以下信息

  • 用户名:为超级用户选择一个唯一的用户名。
  • 电子邮件:输入与超级用户关联的电子邮件地址。
  • 密码:为超级用户设置一个安全的密码。
  • 确认密码:再次输入密码以进行确认。
  • 成功提供所需信息后,将创建超级用户帐户。
  • 现在,您可以使用提供的用户名和密码登录为超级用户并访问管理权限。
  • 创建超级用户允许您以高级权限管理和控制 Laravel 应用程序的各个方面。
  1. 恭喜!:

    如果您可以登录并访问 Laravel 管理器仪表板,那么恭喜!您已成功安装 Laravel 管理器。

使用指南

在本节中,我们将指导您使用 Laravel 管理器对 Seller 模型执行自动 CRUD 操作。

  1. 生成 Seller 模型

    运行以下 Artisan 命令以创建 Seller 模型及其迁移文件

    php artisan make:model Seller -m
    
  2. 定义 Seller 表字段

    在生成的迁移文件中,定义 Seller 表字段,包括 nameemailcitycountryprofile_image

  3. 添加 LaravelAdmin 和 LaravelAdminAPI 特性

    在生成的迁移文件中,定义 Seller 表字段,包括 nameemailcitycountryprofile_image。通过导入 LaravelAdminLaravelAdminAPI 特性来增强你的 Seller 模型功能。

    • Seller 模型类顶部导入 LaravelAdmin 特性

      use Bitsoftsol\LaravelAdministration\Traits\LaravelAdmin;
    • Seller 模型类顶部导入 LaravelAdminAPI 特性

      use Bitsoftsol\LaravelAdministration\Traits\LaravelAdminAPI;
    • Seller 模型类内部添加这两行以包含特性

      use LaravelAdmin;
      use LaravelAdminAPI;
  4. 定义可填充字段

    Seller 模型类中,确保将字段名添加到 fillable 数组中

    protected $fillable = [ "name", "email", "city", "country", "profile_image" ];
  5. 运行迁移

    执行迁移以在你的数据库中创建 sellers

    php artisan migrate
    
  6. 访问管理面板

    打开你的网络浏览器,访问 http://127.0.0.1:8000/admin。这里是你可以通过 CRUD 操作管理你的卖家。

  7. 恭喜!

    你现在能够对 Seller 模型执行 CRUD 操作,而无需编写大量代码。

    本指南使你能够高效地管理 Laravel 应用程序中的卖家。

Postman 指南

要使用 Seller 模型的 CRUD API,请按照以下步骤操作

  1. 导入 Postman 收集

    导入提供的 Postman 收集以有效地访问 CRUD API。您可以从这里下载它:[Postman 收集 - Laravel Administration](https://github.com/hafizSiddiq7675/laravel-administration/blob/HEAD/src/readme-assets/postman/Laravel-Administration.postman_collection.json)。

  2. 导入环境变量

    将环境变量配置导入到 Postman 中以进行无缝测试。您可以从这里下载它:[Postman 环境 - Laravel Administration](https://github.com/hafizSiddiq7675/laravel-administration/blob/HEAD/src/readme-assets/postman/Laravel-Administration.postman_environment.json)。

  3. 设置主机变量

    在 Postman 中,配置 host 变量以匹配您的应用程序的 URL,通常是类似于 http://127.0.0.1:8000 的内容。

  4. 访问登录 API

    向以下 API 端点发送 POST 请求以登录

    • API 端点: (host)/api/admin/login
    • 凭证

    登录成功后,您将收到一个认证令牌。

  5. 设置令牌环境变量

    登录并收到认证令牌后,将其设置为 Postman 中的 (token) 环境变量,以用于后续的 API 请求。

  6. 检索模型 ID

    从以下 API 端点检索 model_id,该端点对应于 Seller 模型

    • API 端点: {{host}}/api/admin/crud/models

    将获得的 model_id 设置为 Postman 中的 (model_id) 环境变量。

  7. 访问 Seller 模型的 CRUD API

    您现在可以使用环境变量访问 Seller 模型的 CRUD API

    • Seller API 列表: {{host}}/api/admin/crud/{{model_id}}
    • Seller 详细信息 API: {{host}}/api/admin/crud/{{model_id}}/2(其中 2 代表卖家的 ID)
    • 存储 Seller API: {{host}}/api/admin/crud/{{model_id}}
    • 更新 Seller API: {{host}}/api/admin/crud/{{model_id}}(在 Postman 的正文选项卡中包含表单数据中的卖家 ID)
    • 删除 Seller API: {{host}}/api/admin/crud/{{model_id}}/3(其中 3 代表卖家的 ID)
  8. 恭喜!

    您现在可以对 Seller 模型执行 CRUD 操作,而无需额外的编码。享受 Laravel Administration 管理卖家的高效便捷。

Schema Builder

在 Laravel Administration 应用程序中,您可以使用 Schema Builder 无缝地创建 Seller 模型及其相关的迁移文件。以下是方法

  1. 访问 Schema Builder

    • 在您的网络浏览器中导航到 (host)/admin/crud-schema/create,将 (host) 替换为您的应用程序的 URL。
  2. 输入模型名称

    • 在提供的页面上,输入 'Seller' 作为模型名称。
  3. 提交

    • 点击“提交”按钮以启动在您的项目中生成卖家模型及其相应的迁移文件。

创建成功后,您将被重定向到模式构建器列表。在这里,您可以在列表中找到“卖家”模型。

管理您的模式

  • 删除模式

    • 要删除“卖家”模型及其迁移文件,请点击“删除”按钮。
  • 定义模式字段

    • 通过点击“创建模式”按钮,您将进入一个视图,可以定义“卖家”迁移的字段,包括添加更多字段的能力。如果您希望在迁移中包含图片字段,请确保给列名加上‘_image’后缀。
  • LaravelAdmin 特性

    • 在“创建模式”视图中,您可以通过勾选复选框来选择是否使用“LaravelAdmin”特性。如果选择,则在该特性定义卖家字段名称时,将自动导入该特性。

编辑模式

创建模式后,您将在模式构建器列表中的“卖家”行中找到一个“打开编辑器”按钮。点击此按钮将跳转到Visual Code Editor视图,允许您编辑“卖家”迁移和模型文件。

  • LaravelAdminAPI 和 LaravelAdmin 特性

    • 在实时编辑器中,如果需要,您可以使用“LaravelAdminAPI”特性,如果需要,也可以包含“LaravelAdmin”特性。这些特性将使您能够通过Web和API接口访问卖家模型的CRUD路由。
  • 定义可填充字段

    • fillable数组中设置“sellers”表的字段。这些字段将在卖家列表视图中显示。

迁移

编辑模型和迁移文件后,您可以点击“迁移”按钮将更改应用到表中。一旦卖家表被迁移,您将无法打开编辑器或执行迁移,但您仍然可以删除。

CRUD 操作

  • LaravelAdmin 特性

    • 如果您已在卖家模型中包含“LaravelAdmin”特性,您可以通过Web界面的“CRUD”选项卡访问卖家CRUD操作。
  • LaravelAdminAPI 特性

    • 如果您已在卖家模型中包含“LaravelAdminAPI”特性,您可以使用Postman Collection访问卖家CRUD操作的API。

恭喜!,您现在已完成了LaravelAdministration文档。您已准备好充分利用这个强大的Laravel开发工具。编码愉快!