Skip to content

docs: 同步 README.md 和 CLAUDE.md 与最新代码结构 #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xlorne merged 1 commit into from
Mar 2, 2026
Merged

docs: 同步 README.md 和 CLAUDE.md 与最新代码结构 #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,22 @@ cd frontend && pnpm install
# 构建所有包
pnpm run build

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

# 构建特定包
pnpm run build:flow-core # 构建核心 API 库
pnpm run build:flow-types # 构建类型定义库
pnpm run build:flow-pc # 构建 PC 端组件库
pnpm run build:flow-core # 核心 API 库
pnpm run build:flow-types # 类型定义库
pnpm run build:flow-pc-ui # 基础 UI 组件库
pnpm run build:flow-pc-form # 表单组件库
pnpm run build:flow-pc-design # 设计器组件库
pnpm run build:flow-pc-approval # 审批组件库

# 构建特定应用
pnpm run build:app-pc

# 开发模式
pnpm run dev:app-pc # PC 端应用
pnpm run dev:app-pc # PC 端应用
pnpm run dev:app-mobile # 移动端应用
```

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

#### 前端应用

| 应用 | 描述 |
|--------|-------------|
| `app-pc` | PC 端应用 |
| `app-mobile` | 移动端应用 |

### 技术栈

- **后端**：Java 17、Spring Boot 3.5.9、Groovy
Expand Down
33 changes: 24 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,11 +211,15 @@ flow-engine
└── frontend # 前端项目
├── apps
│ ├── app-pc # PC端应用
│ └── app-mobile # 移动端应用（开发中）
│ └── app-mobile # 移动端应用
└── packages
├── flow-design # 流程设计器组件库
├── flow-core # 核心 API 库
└── flow-types # TypeScript 类型定义库
├── flow-types # TypeScript 类型定义库
└── flow-pc # PC 端组件库
├── flow-pc-ui # PC 端基础 UI 组件库
├── flow-pc-form # PC 端表单相关组件
├── flow-pc-design # PC 端流程设计器组件
└── flow-pc-approval # PC 端审批页面组件
```

## 技术栈
Expand Down Expand Up @@ -261,11 +265,25 @@ cd frontend
# 安装依赖
pnpm install

# 构建设计库
pnpm run build:flow-engine
# 构建所有包
pnpm run build

# 启动PC端应用
# 构建 PC 端所有组件库
pnpm run build:flow-pc

# 构建特定组件库
pnpm run build:flow-core # 核心 API 库
pnpm run build:flow-types # 类型定义库
pnpm run build:flow-pc-ui # 基础 UI 组件库
pnpm run build:flow-pc-form # 表单组件库
pnpm run build:flow-pc-design # 设计器组件库
pnpm run build:flow-pc-approval # 审批组件库

# 启动 PC 端应用
pnpm run dev:app-pc

# 启动移动端应用
pnpm run dev:app-mobile
```

## 核心架构
Expand Down Expand Up @@ -364,10 +382,7 @@ category.subcategory.errorType

## 文档

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

## 测试

Expand Down