Skip to content

Commit f4d622c

Browse files
authored
Merge pull request #49 from codingapi/dev
docs: 同步 README.md 和 CLAUDE.md 与最新代码结构
2 parents abcde0b + eeb44c3 commit f4d622c

2 files changed

Lines changed: 44 additions & 16 deletions

File tree

CLAUDE.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,22 @@ cd frontend && pnpm install
3636
# 构建所有包
3737
pnpm run build
3838

39-
# 构建特定应用
40-
pnpm run build:app-pc
39+
# 构建 PC 端所有组件库
40+
pnpm run build:flow-pc
4141

4242
# 构建特定包
43-
pnpm run build:flow-core # 构建核心 API 库
44-
pnpm run build:flow-types # 构建类型定义库
45-
pnpm run build:flow-pc # 构建 PC 端组件库
43+
pnpm run build:flow-core # 核心 API 库
44+
pnpm run build:flow-types # 类型定义库
45+
pnpm run build:flow-pc-ui # 基础 UI 组件库
46+
pnpm run build:flow-pc-form # 表单组件库
47+
pnpm run build:flow-pc-design # 设计器组件库
48+
pnpm run build:flow-pc-approval # 审批组件库
49+
50+
# 构建特定应用
51+
pnpm run build:app-pc
4652

4753
# 开发模式
48-
pnpm run dev:app-pc # PC 端应用
54+
pnpm run dev:app-pc # PC 端应用
4955
pnpm run dev:app-mobile # 移动端应用
5056
```
5157

@@ -115,9 +121,16 @@ flow-types (类型定义)
115121
- **flow-types**:全局类型定义,包含流程审批相关的业务类型(手机端和 PC 端共用)
116122
- **flow-pc-ui**:PC 端基础 UI 组件库,提供原子化组件
117123
- **flow-pc-form**:表单相关功能,依赖 flow-core + flow-types
118-
- **flow-pc-design**:流程设计器功能,包含节点配置、属性面板、脚本配置等(本次优化的主要模块)
124+
- **flow-pc-design**:流程设计器功能,包含节点配置、属性面板、脚本配置等
119125
- **flow-pc-approval**:审批页面功能,依赖 flow-pc-design
120126

127+
#### 前端应用
128+
129+
| 应用 | 描述 |
130+
|--------|-------------|
131+
| `app-pc` | PC 端应用 |
132+
| `app-mobile` | 移动端应用 |
133+
121134
### 技术栈
122135

123136
- **后端**:Java 17、Spring Boot 3.5.9、Groovy

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -211,11 +211,15 @@ flow-engine
211211
└── frontend # 前端项目
212212
├── apps
213213
│ ├── app-pc # PC端应用
214-
│ └── app-mobile # 移动端应用(开发中)
214+
│ └── app-mobile # 移动端应用
215215
└── packages
216-
├── flow-design # 流程设计器组件库
217216
├── flow-core # 核心 API 库
218-
└── flow-types # TypeScript 类型定义库
217+
├── flow-types # TypeScript 类型定义库
218+
└── flow-pc # PC 端组件库
219+
├── flow-pc-ui # PC 端基础 UI 组件库
220+
├── flow-pc-form # PC 端表单相关组件
221+
├── flow-pc-design # PC 端流程设计器组件
222+
└── flow-pc-approval # PC 端审批页面组件
219223
```
220224

221225
## 技术栈
@@ -261,11 +265,25 @@ cd frontend
261265
# 安装依赖
262266
pnpm install
263267

264-
# 构建设计库
265-
pnpm run build:flow-engine
268+
# 构建所有包
269+
pnpm run build
266270

267-
# 启动PC端应用
271+
# 构建 PC 端所有组件库
272+
pnpm run build:flow-pc
273+
274+
# 构建特定组件库
275+
pnpm run build:flow-core # 核心 API 库
276+
pnpm run build:flow-types # 类型定义库
277+
pnpm run build:flow-pc-ui # 基础 UI 组件库
278+
pnpm run build:flow-pc-form # 表单组件库
279+
pnpm run build:flow-pc-design # 设计器组件库
280+
pnpm run build:flow-pc-approval # 审批组件库
281+
282+
# 启动 PC 端应用
268283
pnpm run dev:app-pc
284+
285+
# 启动移动端应用
286+
pnpm run dev:app-mobile
269287
```
270288

271289
## 核心架构
@@ -364,10 +382,7 @@ category.subcategory.errorType
364382

365383
## 文档
366384

367-
- [PRD.md](PRD.md) - 产品需求文档
368-
- [Design.md](Design.md) - 架构设计文档
369385
- [CLAUDE.md](CLAUDE.md) - Claude Code 指南
370-
- [TODO.md](TODO.md) - 开发进度
371386

372387
## 测试
373388

0 commit comments

Comments
 (0)