# scaffold

**Repository Path**: zeyc/scaffold

## Basic Information

- **Project Name**: scaffold
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: feature/license
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 3
- **Created**: 2026-04-02
- **Last Updated**: 2026-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Scaffold V2 企业级应用开发平台

Scaffold V2 是一个基于 Spring Boot + Vue 3 + uni-app 构建的现代化企业级应用开发平台，采用四层架构设计，支持多租户、多端（PC Web、移动端、小程序）一体化开发。

## 项目特性

### 核心架构
- **后端**: Spring Boot 3.x + MyBatis-Plus + 多模块可插拔架构
- **前端**: Vue 3 + Element Plus + TypeScript
- **移动端**: uni-app (Vue 3) + uView UI 3.0
- **工作流引擎**: 自研 BPM 流程引擎，支持飞书、钉钉、企业微信多平台集成

### 功能模块

| 模块 | 说明 |
|------|------|
| scaffold-bpm | 流程引擎，支持多平台审批集成 |
| scaffold-cms | 内容管理（文章、公告、标签） |
| scaffold-coupon | 优惠券模板、发放、核销 |
| scaffold-finance | 财务模块（会计科目、凭证、结算） |
| scaffold-product | 商品管理（SPU/SKU、库存） |
| scaffold-wechat | 微信集成（支付、公众号、小程序） |
| scaffold-lowcode | 低代码平台 |
| scaffold-mobile-page | 移动端页面设计器 |
| scaffold-audit | 审计日志、操作追踪 |
| scaffold-job | 定时任务调度 |
| scaffold-import-export | 数据导入导出 |

### 基础设施

| 模块 | 说明 |
|------|------|
| scaffold-security | 安全认证、JWT、多租户 |
| scaffold-redis | 缓存、分布式锁 |
| scaffold-tenant | 多租户隔离 |
| scaffold-datapermission | 数据权限控制 |
| scaffold-system | 系统管理（用户、角色、菜单） |
| scaffold-file | 文件存储（本地/MinIO） |

## 技术栈

### 后端
- Java 17
- Spring Boot 3.3.x
- MyBatis-Plus 3.5.x
- Spring Security 6.x
- Redis
- MySQL 8.x

### 前端
- Vue 3.4+
- TypeScript 5.x
- Element Plus
- Pinia (状态管理)
- Vite 5.x

### 移动端
- uni-app (Vue 3)
- uView UI 3.0
- 微信小程序/H5/App 多端支持

## 快速开始

### 后端启动

```bash
# 编译所有模块
cd scaffold-server
mvn clean install -DskipTests

# 启动应用（默认端口 8080）
mvn spring-boot:run -pl scaffold-admin
```

### 前端启动

```bash
# 安装依赖
cd scaffold-web
npm install

# 开发模式启动
npm run dev
```

### 移动端启动

```bash
cd scaffold-mobile
npm install
# 运行到微信开发者工具
npm run dev:mp-weixin
# 运行到 H5
npm run dev:h5
```

## 配置说明

### 数据库连接

配置文件位于 `scaffold-server/scaffold-admin/src/main/resources/application.yml`:

```yaml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/scaffold?useUnicode=true&characterEncoding=utf-8
    username: root
    password: ${DB_PASS}
```

### 环境变量

| 变量 | 说明 |
|------|------|
| DB_PASS | 数据库密码 |

## 项目结构

```
scaffold-server/          # 后端服务
├── scaffold-admin/        # 启动入口
├── scaffold-common/     # 公共模块
├── scaffold-bpm/        # 流程引擎
├── scaffold-cms/       # 内容管理
├── scaffold-coupon/    # 优惠券
├── scaffold-finance/    # 财务
├── scaffold-product/   # 商品
├── scaffold-wechat/     # 微信
├── scaffold-lowcode/    # 低代码
└── ...

scaffold-web/           # PC 端前端
scaffold-mobile/       # 移动端
```

## BPM 流程引擎

Scaffold V2 内置自研流程引擎，支持：

- 流程定义管理（创建、发布、版本控制）
- 流程实例管理（启动、审批、终止）
- 任务管理（待办、已办、转交、委派）
- 多平台集成（飞书/钉钉/企业微信审批）
- 统计分析

### API 端点

| 路径 | 说明 |
|------|------|
| `/v1/bpm/process-definition` | 流程定义管理 |
| `/v1/bpm/process-instance` | 流程实例管理 |
| `/v1/bpm/task` | 任务管理 |
| `/v1/bpm/statistics` | 统计分析 |

## 低代码平台

支持可视化建模、表单设计、列表设计、页面配置：

- 模型与字段管理
- 表单/列表页面设计
- 按钮动作配置
- 联动规则
- 发布中心

## 部署

### Docker 部署

```bash
# 使用 docker-compose 一键启动
docker-compose up -d
```

### Nginx 配置

项目包含完整的 Nginx 配置模板，支持：
- 前端静态资源托管
- API 反向代理
- WebSocket 支持
- Gzip 压缩

## 文档

详细设计文档见 `docs/` 目录：

- `BACKEND_ARCHITECTURE.md` - 后端架构设计
- `FRONTEND_ARCHITECTURE.md` - 前端架构设计
- `MOBILE_ARCHITECTURE.md` - 移动端架构设计
- `BPM_DESIGN.md` - 流程引擎设计
- `DATABASE_DESIGN.md` - 数据库设计

## 开源协议

MIT License

## 贡献指南

欢迎提交 Issue 和 Pull Request。提交代码前请确保：

1. 遵循项目编码规范
2. 通过单元测试
3. 更新相关文档