flatpack/flatpack

Flatpack:Laravel的管理面板,随时组装。

v1.0.17 2023-12-15 18:49 UTC

README

Image of package

Latest Version on Packagist License Test Coverage GitHub Tests Status GitHub Code Style Status

Flatpack

📦 Laravel的管理面板,随时组装。

  • 快速为你的Eloquent模型创建CMS。
  • 使用简单的声明式YAML文件定义组件。
  • 几秒钟内为你的Laravel应用构建完整的管理面板。

📕 官方文档

Flatpack 使构建功能齐全的用户界面比以往任何时候都更容易:只需编辑几行YAML文件即可。

除了提供丰富的预构建组件和稳定的堆栈来构建安全和直观的用户体验外,它还为想要享受乐趣、尝试新事物并节省宝贵时间构建管理面板的开发者提供了一个快速灵活的解决方案。

Flatpack是一个响应式的全栈应用程序,使用 TALL堆栈 构建。

Demo

快速安装

通过composer安装包

composer require flatpack/flatpack

发布配置文件和编译后的资源文件

php artisan vendor:publish --tag="flatpack"

注意:为确保公共资源始终是最新的,请记住将此命令添加到您的 composer.json 文件中的 post-update-cmd 列表。

  "post-update-cmd": [
      "@php artisan vendor:publish --tag=flatpack"
  ],

使用方法

App\Models\Post 模型生成Flatpack组合文件...

php artisan make:flatpack Post

此命令将创建两个文件

  • 一个表单模板 /flatpack/posts/form.yaml,用于定义文章表单。
  • 一个列表模板 /flatpack/posts/list.yaml,用于定义具有分页的文章表。

让我们查看结果,访问 /backend/posts

现在开始组装,获取生成的文件,并根据需要映射模型属性。

示例

定义一个表单

title: Post
model: App\Models\Post
icon: book-open

toolbar:
  save:
    type: button
    label: Save
    action: save
    style: primary
    shortcut: s

main:
  title:
    label: Post Title
    placeholder: Your Post Title
    type: text

  body:
    type: block-editor

sidebar:
  created_at:
    label: Created
    type: datetime-picker

  updated_at:
    label: Updated
    type: datetime-picker

定义一个列表

title: Post
model: App\Models\Post
icon: book-open
order: 1

toolbar:
  create:
    label: New Post
    icon: plus
    link: create
    style: primary
    shortcut: enter

columns:
  id:
    label: ID
    sortable: true
    invisible: true

  title:
    label: Title
    sortable: true
    searchable: true

  created_at:
    label: Created
    type: datetime
    format: "Y-m-d H:i:s"
    sortable: true

  updated_at:
    label: Updated
    type: datetime
    format: "Y-m-d H:i:s"
    sortable: true

⚙️ 你可以通过映射模型属性、使用不同类型和功能的组件(如数据表、文本输入、富文本编辑器、日期选择器、标签选择器、可搜索的菜单、图片上传、切换等)来自定义yaml组合文件。

📖 查看文档

要求

  • PHP 8.x
  • Composer
  • Laravel 9.x

更新日志

请查看 更新日志 了解最近更改的详细信息。

贡献

欢迎贡献!请参阅 贡献指南 了解详情。

安全漏洞

请查阅 我们的安全策略 了解如何报告安全漏洞。

致谢

许可证

MIT许可证(MIT)。请参阅 许可证文件 了解更多。