# zhicloud_hcms

**Repository Path**: Gibson0804/zhicloud_hcms

## Basic Information

- **Project Name**: zhicloud_hcms
- **Description**: 织云HCMS（ZhiCloud Headless CMS） 是一个面向"内容类型"的低代码后端平台，提供可视化建模、内容管理、媒体管理、对外 API、云函数与任务化能力，无头cms和baas服务结合，并内置 MCP 服务用于 AI/Agent 集成与扩展。
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2024-01-30
- **Last Updated**: 2026-04-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# HCMS

HCMS 是一个面向"内容类型"的低代码后端平台，提供可视化建模、内容管理、媒体管理、对外 API、云函数与任务化能力，并内置 MCP 服务用于 AI/Agent 集成与扩展。

## 项目定位

- **内容驱动的低代码 Backend**：以"内容类型/字段/表单"为核心，将管理后台、接口与扩展能力统一在一个项目内管理
- **Headless CMS + BaaS 能力融合**：除传统内容建模/发布外，提供云函数（HTTP Endpoint/Hook）、触发器、定时任务、插件与多种 API 访问面

## 核心特性

- **内容类型与字段建模**：可视化创建和维护内容模型与字段，支持 20 种字段类型
- **AI 辅助建模**：使用自然语言描述需求，AI 自动生成表单结构
- **AI 内容生成**：支持单个和批量生成内容
- **内容管理**：完整的 CRUD 操作，支持发布/草稿状态、版本控制、对比回滚
- **媒体资源管理**：文件上传、文件夹管理、标签管理、批量操作
- **对外 API**：
  - Open API（`/open/`）：基于项目与 API Key 的开放接口
  - Client API（`/client`）：面向官方客户端的 Token 鉴权接口
- **云函数与自动化**：
  - Web 函数（HTTP Endpoint）：自定义 API 端点
  - 触发函数（Hook）：事件触发的自动化逻辑
  - 触发器（Triggers）：基于条件的自动化规则
  - 定时任务（Crons）：基于 Cron 表达式的定时执行
- **OpenAPI 自动生成**：根据模型和函数自动生成 API 文档
- **MCP 服务**：内置 MCP Server，支持 AI 助手访问系统数据
- **插件系统**：可扩展的插件架构，支持自定义功能
- **任务中心**：异步任务处理，支持进度查看、取消、重试
- **项目级隔离**：以 `prefix` 作为项目维度，相关数据表按项目隔离

## 技术栈

- **后端**：PHP 8.2+, Laravel 11.x
- **前端**：React 18, TypeScript, Vite
- **数据库**：SQLite (开发), MySQL (生产)
- **队列**：database / sync
- **缓存**：file / database

## 快速开始

### 环境要求

- PHP >= 8.2
- Composer
- Node.js >= 18
- npm >= 9

### 本地一键安装

```bash
git clone https://github.com/your-repo/hcms.git
cd hcms

# Linux / macOS
./bin/install.sh

# Windows
bin\install.bat
```

默认行为：

- 本地默认使用 SQLite，不依赖 Redis
- 本地开发可直接使用 `php artisan serve`，不依赖 Nginx
- 若仓库中已有 `public/build`，安装时可不依赖 Node.js / npm
- 安装器会自动创建 `storage/framework/*`、`storage/logs`、`bootstrap/cache` 并检查可写性

也可以手动执行：

```bash
composer install
php artisan hcms:install --name=Admin --email=admin@example.com --password=admin123456
```

### 启动开发服务器

**macOS/Linux:**

```bash
# 使用启动脚本（推荐）
./bin/start.sh

# 或手动启动
php artisan serve --host=0.0.0.0 --port=9445
php artisan queue:work
```

**Windows:**

```cmd
# 使用启动脚本（推荐）
bin/start.bat

# 或手动启动
php artisan serve --host=0.0.0.0 --port=9445
php artisan queue:work
```

### 访问应用

- 管理后台：http://127.0.0.1:9445
- 安装向导：http://127.0.0.1:9445/install

## 文档

详细的文档请查看 [docs/](docs/) 目录：

- **[入门指南](docs/2.入门指南/)**：环境要求、安装、配置、部署、快速开始、目录结构
- **[核心能力](docs/3.核心能力/)**：低代码拖拽表单、AI 辅助建模、MCP 服务、OpenAPI、任务化能力
- **[基础功能](docs/4.基础功能/)**：仪表盘、项目管理、内容管理、媒体资源、云函数、插件管理等 23 个功能模块
- **[开发者指南](docs/5.开发者指南/)**：架构总览、本地开发、路由规范、插件开发、MCP 集成、测试与质量、安全
- **[附录](docs/6.附录/)**：常见问题、术语表

## 常用命令

```bash
# 启动开发服务器（并发启动 server/queue/logs/vite）
bin/start.sh

# 一键安装（默认 SQLite）
php artisan hcms:install

# 创建插件
bin/create-plugin.sh

# 生成格式化插件 plugin.json 标准文件
bin/generate-plugin-json.sh

```


## 贡献

欢迎贡献代码、报告问题或提出建议。详见 [贡献指南](docs/1.前言/03-贡献指南.md)。

## 许可证

MIT License

## 联系方式

- GitHub Issues：[提交问题](https://github.com/your-repo/hcms/issues)
- 文档：[查看完整文档](docs/)