README

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

Craftable - 使用 Laravel 构建 admin 面板

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

关于

您好，Craftable 用户，欢迎来到 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
• 翻译 - 您可以在此处管理存储在数据库中的翻译

由组件组成

我们的目标是尽可能减少依赖，将所有内容拆分为多个包。以下是当前提供的内容

• Admin UI - 管理模板（CoreUI 资产、blades、Vue）
• Admin Generator - Eloquent 模型的 CRUD 生成器
• Admin Authentication - 能够登录到管理区域
• Translatable - 能够拥有可翻译的内容（扩展 Laravel 的默认本地化功能）
• Admin Listing - 能够快速构建 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使用的其他包的完整文档。

下一步去哪里？

在此阶段，您已准备好开始构建您的管理区域。您可能想要为eloquent模型构建一个典型的CRUD界面。您绝对应该查看我们的管理生成器文档。

如果您想创建一些非典型的定制管理，那么您可能想转到管理UI包。

祝您玩得开心，创造一些令人惊叹的东西！

如何贡献

• 在Github仓库上留下⭐（可选）
  

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

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

• 将仓库Fork到您的Github。
  

• 通过进入您的本地Git客户端中的特定本地文件夹，使用以下命令通过您的Forked仓库链接克隆仓库
  git clone https://github.com/BRACKETS-by-TRIAD/craftable

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

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

• 将你的代码添加到本地计算机文件夹中。 git add .

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

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

• 发起一个拉取请求！ (比较你的分支与所有者的主分支)

贡献者🌟

向这些了不起的人致敬

许可

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