From b4f2a9d400c05b90efc51c12d501157bceb82663 Mon Sep 17 00:00:00 2001 From: dengqichen Date: Thu, 30 Oct 2025 17:26:12 +0800 Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=E5=9B=A2=E9=98=9F=E7=AE=A1?= =?UTF-8?q?=E7=90=86=E9=A1=B5=E9=9D=A2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- frontend/README.md | 101 +++++++++++++++++++++++++++------------------ 1 file changed, 61 insertions(+), 40 deletions(-) diff --git a/frontend/README.md b/frontend/README.md index 0584becf..66192f30 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -17,7 +17,7 @@ Deploy Ease Platform 是一个现代化的部署管理平台前端项目,基 ## 项目结构 -\`\`\` +``` src/ ├── components/ # 公共组件 │ └── ui/ # shadcn/ui 组件 @@ -34,48 +34,63 @@ src/ ├── utils/ # 工具函数 ├── hooks/ # 自定义 Hooks └── types/ # TypeScript 类型定义 -\`\`\` +``` ## 功能模块 -### 1. 系统管理 -- 用户管理 -- 角色管理 -- 菜单管理 -- 部门管理 +### 已完成的核心功能一览 -### 2. 部署管理 -- 项目组管理 -- 应用管理 -- 环境管理 -- 部署配置 -- Jenkins管理 -- 外部系统集成 +#### 1. 系统管理 +- 用户管理:增删改查、批量分配、导出等 +- 角色管理:角色维护、权限配置、分发 +- 菜单管理:菜单结构管理、权限绑定 +- 部门管理:组织结构树、成员关系 -### 3. 工作流管理 -- 工作流定义 -- 工作流设计器 -- 工作流实例 -- 节点设计 -- 工作流监控 -- 日志流 +#### 2. 部署管理 +- 项目组管理:分层架构/可视化呈现 +- 应用管理:基础信息、分类、编辑、上下线 +- 环境管理:多环境切换与隔离 +- 部署配置:CICD配置、模板配置、自动化脚本 +- Jenkins 管理:流水线、任务触发、日志采集 +- 外部系统集成:Git、Docker、K8s、通知等系统对接 +- 服务器管理:资产登记、分组、状态监控 +- 定时任务管理:任务启/停/禁/恢复/立即执行、操作日志、cron表达式、分组管理 + +#### 3. 工作流管理 +- 流程定义:自定义流程模板,版本管理 +- 工作流设计器:可视化流程图绘制、条件设置、节点属性 +- 流程实例:流程启动、节点状态追踪、审批流转 +- 节点设计:节点表单、流转条件、校验 +- 工作流监控:流程监控、实例追踪、事件审计 +- 日志流:关键流转日志、运行详情、异常追踪 + +#### 4. 表单/低代码支持 +- 表单设计器:字段联动、校验、模板保存、可视化拖拉拽 +- 表单数据管理:详情、查询、审批流适配 + +#### 5. 其他与基础 +- 登录/注册及权限校验:自动跳转,支持Token、菜单动态加载 +- 公共布局框架:全局导航、响应式菜单、顶部头部(用户信息、天气、通知) +- 实时消息与操作提示:全平台toast、弹窗反馈 +- RESTful API统一封装,异常处理、自动重定向、全局错误反馈 +- 脚本化、模板化页面快速生成工具,覆盖开发全生命周期 ## 开发指南 ### 安装依赖 -\`\`\`bash +```bash pnpm install -\`\`\` +``` ### 开发环境运行 -\`\`\`bash +```bash pnpm dev -\`\`\` +``` ### 构建生产环境 -\`\`\`bash +```bash pnpm build -\`\`\` +``` ## 页面生成工具 @@ -84,31 +99,31 @@ pnpm build ### 使用方法 1. 编译生成器: -\`\`\`bash +```bash npx tsc -p scripts/tsconfig.json -\`\`\` +``` 2. 运行生成器(两种方式): a. 交互式模式: - \`\`\`bash + ```bash node dist/scripts/generate-page.js - \`\`\` + ``` b. 命令行参数模式: - \`\`\`bash + ```bash node dist/scripts/generate-page.js user "用户管理" "/api/v1/users" - \`\`\` + ``` ### 生成的文件结构 -生成器会在 \`src/pages/[模块名]/List/\` 目录下创建以下文件: +生成器会在 `src/pages/[模块名]/List/` 目录下创建以下文件: -- \`types.ts\`: 类型定义 -- \`schema.ts\`: 表单验证 schema -- \`service.ts\`: API 服务 -- \`index.tsx\`: 列表页面组件 -- \`components/[模块名]Modal.tsx\`: 编辑弹窗组件 +- `types.ts`: 类型定义 +- `schema.ts`: 表单验证 schema +- `service.ts`: API 服务 +- `index.tsx`: 列表页面组件 +- `components/[模块名]Modal.tsx`: 编辑弹窗组件 生成的页面包含以下功能: - 列表展示 @@ -157,4 +172,10 @@ npx tsc -p scripts/tsconfig.json ## 许可证 -[MIT License](LICENSE) \ No newline at end of file +[MIT License](LICENSE) + +--- + +## 当前进度总结 + +Deploy Ease Platform 前端现已全面实现了企业级部署自动化、权限组织、流程设计、定时任务调度、低代码表单等主流能力,覆盖了从组织管控到应用交付、流程编排与运维监控的全业务链路。架构高度模块化、类型定义严格,接口与UI解耦,利于多团队协作与持续扩展。整体技术栈现代,体验优良,适用于现代云运维、DevOps与低代码平台的前端技术解决方案。