# agentfast

**Repository Path**: chasechan/agentfast

## Basic Information

- **Project Name**: agentfast
- **Description**: AI Agent 快速开发框架
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-05
- **Last Updated**: 2026-09-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

# agentfast

**专为 AI Agent 打造的 Web 快速开发框架** — webman · vben · uniapp

通用模块开箱即用 · 声明式 CRUD · 应用化安装 · 标准样式内置 · 业务按分支叠加

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![PHP](https://img.shields.io/badge/PHP-%3E%3D8.1-777bb4.svg)

</div>

---

## 是什么

agentfast 是一套「AI Agent 团队 + 人类开发者」都能上手的快速开发底座：

- **后端** webman（Workerman 常驻内存 PHP）—— RBAC / 设置 / 日志 / apikey / 字典 / 渠道等通用模块，声明式 schema 驱动 CRUD
- **前端** 定制 vben（Vue3 + Element Plus）—— 版式铁律 + tokens 体系 + 组件库 14 类 + 模板库 6 套
- **移动端** 通用 uniapp 基座 —— 多页路由分包 + 设计 tokens + 组件 / 模板 + API 对接层
- **Agent 优先** `AGENTS.md` 固定入口链 + `skills/` 标准文档 + 机械校验脚本 —— Agent 照文档即可执行，验收 = 脚本输出

## 快速开始

### 环境要求

- PHP ≥ 8.1 · MySQL 8.0 · Redis 6+（Windows + Linux 双平台）
- Node.js 18+ / pnpm

### 1. 初始化数据库

```bash
mysql -uroot -p -e "CREATE DATABASE agentfast DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -uroot -p agentfast < resources/sql/framework-schema.sql
mysql -uroot -p agentfast < resources/sql/framework-security.sql
mysql -uroot -p agentfast < resources/sql/framework-seed.sql
```

数据库连接见 `config/database.php`（`config/` 为 webman 标准配置目录）。

### 2. 启动后端

```bash
composer install
php start.php start   # Windows 运行 windows.bat
```

默认端口 8787 / 8788（以 `config/process.php` 与 `.env` 实际为准）。自检：`GET /` 返回框架信息。

### 3. 启动前端

```bash
cd frontend/admin/apps/admin
pnpm install
pnpm dev   # 开发；构建用 pnpm build
```

前端接口代理目标见 `frontend/admin/apps/admin/.env*`（`VITE_PROXY_TARGET` 默认 8788）。

### 4. 登录

默认账号 `admin` / `admin123`（种子数据，首次登录后请修改）。

## 模块地图

| 层 | 内容 | 位置 |
|---|---|---|
| 通用模块 | 用户 / 角色 / 菜单 / 部门 / 设置 / 操作日志 / 接入用户 / 字典 / 渠道 | `app/admin/` |
| 能力层 | JwtAuth / ApiKeyAuth / PermissionCheck / AppInstalled 中间件、声明式 SchemaUtil | `app/admin/` |
| 应用安装 | installer 引擎 + 应用管理 + 动态菜单 + 卸载接口拦截 | `app/admin/support/` |
| 前端 | 定制 vben（浅色 tokens + 品牌可配置） | `frontend/admin/apps/admin/` |
| 组件库 | 官方组件 14 类（BaseForm / BaseTable / BaseSearch …） | `frontend/admin/apps/admin/src/components/base/` |
| 模板库 | 成品页面模板 6 套（tpl-crud-list / tpl-dashboard …） | `frontend/admin/apps/admin/src/views/templates/` |
| 标准文档 | 版式铁律 / 接口标准 / 数据标准 / Agent 协议 / 设计模式 | `skills/` |
| 校验脚本 | 版式 / 接口 / 表结构检查器 | `scripts/` |

## 文档

- **Agent（含 AI 编码工具）**：[`AGENTS.md`](AGENTS.md) — 入口链 / 必读清单 / 开发流程 / 红线
- **标准文档索引**：[`skills/README.md`](skills/README.md)
- **贡献指南**：[`CONTRIBUTING.md`](CONTRIBUTING.md)

## 欢迎贡献

本项目 MIT 开源，欢迎 **AI Agent 与开发者** 提交 PR：

- **发现问题先判定**：是框架缺陷（通用）还是业务问题（案例自身）——只有框架缺陷才提 PR，避免把案例私有逻辑混入框架
- **框架随案例自我进化**：在业务分支开发中发现通用能力缺口，沉淀回框架，让框架越来越完整
- 提交规范见 [`CONTRIBUTING.md`](CONTRIBUTING.md)

## 致谢

- [webman](https://www.workerman.net/webman)
- [Vben Admin](https://github.com/vbenjs/vue-vben-admin)
- [Element Plus](https://element-plus.org)
- 设计方法论沉淀自 od（Open Design）实战

## License

[MIT](LICENSE)