README

我们刚刚发布了 Craftable PRO - 这款流行的开源 Laravel 管理面板构建器的付费版本。Pro 版本包含基于 Tailwind 的全新 UI，使用最新的 Laravel 和 InertiaJS，并带有许多 新功能。

Craftable - 使用 Laravel 构建 admin 面板

• 关于
  • 演示
  • 使用的包
• 要求
• 安装
  • 新建项目
  • 添加到现有项目
• 基础
• 文档
• 下一步去哪里？

关于

你好，Crafter，欢迎来到 Craftable 6 的官方文档 - 基于 Laravel 的开源构建管理界面的工具包。这是一个简约式的管理区域模板。它是开发后台系统、内部网或 CMS 系统的起点。

你可以称它为 CMS，但这是一个非常精简的版本，尽可能减少需要管理的内容。它具有以下功能：

• UI - 基于 CoreUI (http://coreui.io/) 的精美管理模板
• CRUD 生成器
• 授权、我的资料 & 用户 CRUD
• 翻译管理器
• 其他辅助工具，以便快速启动新的管理区域（媒体库、管理列表等）

演示

我们在 https://demo.getcraftable.com 为您创建了一个演示。

使用以下凭据登录

• 邮箱：demo@getcraftable.com
• 密码：demo123

您可以查看以下管理内容：

• 帖子 - 这是使用 admin-generator 包生成的标准 CRUD
• 可翻译文章 - 这是 translatable eloquent 模型的展示
• 管理访问 - 是用户（您现有的 eloquent 模型）管理的扩展 CRUD
• 翻译 - 您可以在此处管理数据库中存储的翻译

由组件组成

我们的意图是将所有内容拆分成尽可能少的依赖的几个包。以下是我们的当前成果：

• 管理 UI - 管理模板（CoreUI 资产、blades、Vue）
• 管理生成器 - Eloquent 模型的 CRUD 生成器
• 管理认证 - 能够登录到管理区域
• 可翻译 - 能够拥有可翻译的内容（扩展 Laravel 的默认本地化）
• 管理列表 - 能够快速为 Eloquent 模型构建管理列表的查询
• 媒体库 - 将媒体附加到eloquent模型的能力
• 管理翻译 - 翻译管理器（带UI）

Craftable使用上述所有包。它还使用一些其他第三方包（如Spatie的spatie/laravel-permission）并提供一些基本的默认配置，以加快典型管理界面的开发。

要求

Craftable需要

• PHP 7.4+
• 支持的数据库
  • MySQL 5.7+
  • PostgreSQL 9.5+
• npm 5.3+
• node 8.4+

Craftable使用Laravel，因此您也应该检查其要求。它与Laravel 8兼容

• https://laravel.net.cn/docs/8.x/installation#server-requirements

安装

新Craftable项目

如果您想从全新的Laravel开始，可以使用我们的brackets/craftable-installer，它为您做所有这些工作。让我们全局安装它

composer global require "brackets/craftable-installer"

创建一个空数据库（PostgreSQL或MySQL）。

现在您可以创建一个新的Craftable项目

craftable new my_project

这将使用最新的Laravel版本（目前为6）安装Craftable。如果您希望使用最新的LTS Laravel版本（目前也为6），请使用--lts标志

craftable new --lts my_project

该命令将要求您输入数据库设置，然后它会设置一切（安装所有依赖项、发布所有重要供应商配置、迁移、设置一些配置、webpack配置并运行迁移）。

命令将生成并打印默认管理员帐户的密码。将此密码保存到您的剪贴板，我们很快就会需要它。

将Craftable添加到现有项目

或者，您也可以使用现有的Laravel应用程序。从要求这两个主要包开始

composer require brackets/craftable
composer require --dev brackets/admin-generator

要安装此包，请使用

php artisan craftable:install

这将安装所有依赖项、发布所有重要供应商配置、迁移、设置一些配置、webpack配置并运行迁移。

命令将生成并打印默认管理员帐户的密码。将此密码保存到您的剪贴板，我们很快就会需要它。

基础

安装完成后，导航到浏览器中的/admin/login。您应该能看到一个登录界面。

使用以下凭据登录

• 电子邮件： administrator@brackets.sk
• 密码：使用您剪贴板中的密码（在craftable:install命令的末尾打印出来）

授权后，您应该能看到默认主页和两个菜单项

• 管理访问
• 翻译

文档

您可以在https://docs.getcraftable.com/#/craftable找到此包以及Craftable使用的其他包的完整文档。

运行测试

要运行测试，请使用此Docker环境。

  docker-compose run -it test vendor/bin/phpunit

要切换到postgresql和mariadb，请更改docker-compose.yml中的DB_CONNECTION环境变量

- DB_CONNECTION: pgsql
+ DB_CONNECTION: mysql

下一步去哪里？

至此，您已经准备好开始构建您的管理区域。您可能想开始为eloquent模型构建典型的CRUD界面。您绝对应该检查我们的Admin Generator文档。

如果您更愿意创建一些非典型的自定义管理界面，那么您可能想转到Admin UI包。

祝您玩得开心，创造一些精彩的东西！

如何贡献

• 在GitHub仓库上点一个⭐（可选）
  

• 在贡献之前，请阅读CONTRIBUTING.md和CODE_OF_CONDUCT.md。

• 为项目创建一个问题或您想要添加到项目中的功能，并为您分配任务。（问题可以是任何错误修复或您想要添加到本项目中的任何功能）。

• 将仓库Fork到您的GitHub。
  

• 通过使用以下命令，在您的本地Git客户端中克隆仓库到您的本地计算机上特定文件夹中
  使用以下命令克隆仓库：git clone https://github.com/BRACKETS-by-TRIAD/craftable

• 使用以下命令创建分支：git branch <你的分支名称>

• 切换到你的分支：git checkout <你的分支名称>

• 在你的本地机器文件夹中添加你的代码：git add .

• 提交你的更改：git commit -m"<在此处添加你的信息>"

• 推送你的更改：git push --set-upstream origin <你的分支名称>

• 发起一个Pull Request！ (比较你的分支与所有者的主分支)

贡献者🌟

向这些杰出的人致以敬意

许可证

MIT许可证。有关更多信息，请参阅LICENSE文件。