166 lines
3.4 KiB
Markdown
166 lines
3.4 KiB
Markdown
|
|
# Monisuo 开发技能使用指南
|
|||
|
|
|
|||
|
|
## 快速开始
|
|||
|
|
|
|||
|
|
### 1. 使用技能
|
|||
|
|
|
|||
|
|
在 OpenClaw 中提及 "monisuo 开发" 即可触发此技能。
|
|||
|
|
|
|||
|
|
### 2. 开发流程
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
需求分析 → 模块化开发 → 测试验证 → 构建部署
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 详细说明
|
|||
|
|
|
|||
|
|
### Phase 1: 需求结构化定义
|
|||
|
|
|
|||
|
|
**目标**: 将需求转化为结构化的 Feature Spec
|
|||
|
|
|
|||
|
|
**步骤**:
|
|||
|
|
1. 收集需求信息
|
|||
|
|
2. 创建 `docs/features/[功能名].md`
|
|||
|
|
3. 填写 Feature Spec 模板
|
|||
|
|
4. 评审并确认
|
|||
|
|
|
|||
|
|
**模板位置**: `docs/features/FEATURE_TEMPLATE.md`
|
|||
|
|
|
|||
|
|
### Phase 2: 模块化开发
|
|||
|
|
|
|||
|
|
**目标**: 按模块实现功能
|
|||
|
|
|
|||
|
|
**步骤**:
|
|||
|
|
1. 根据设计文档实现代码
|
|||
|
|
2. 遵循代码规范
|
|||
|
|
3. 使用设计系统(AppSpacing, AppRadius, AppColorScheme)
|
|||
|
|
4. 提交代码
|
|||
|
|
|
|||
|
|
**Flutter 开发**:
|
|||
|
|
```bash
|
|||
|
|
cd flutter_monisuo
|
|||
|
|
flutter pub get
|
|||
|
|
flutter run -d chrome
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Admin 开发**:
|
|||
|
|
```bash
|
|||
|
|
cd monisuo-admin
|
|||
|
|
pnpm install
|
|||
|
|
pnpm dev
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### Phase 3: 测试与重构
|
|||
|
|
|
|||
|
|
**目标**: 确保代码质量和功能正确性
|
|||
|
|
|
|||
|
|
**步骤**:
|
|||
|
|
1. 应用 clean-code 技能优化代码
|
|||
|
|
2. 编写/更新 API 测试脚本
|
|||
|
|
3. 运行测试脚本
|
|||
|
|
4. 修复 Bug 直到全部通过
|
|||
|
|
|
|||
|
|
**运行 API 测试**:
|
|||
|
|
```bash
|
|||
|
|
cd tests/api
|
|||
|
|
chmod +x test-template.sh
|
|||
|
|
./test-template.sh
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Flutter 单元测试**:
|
|||
|
|
```bash
|
|||
|
|
cd flutter_monisuo
|
|||
|
|
flutter test
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### Phase 4: 构建与部署
|
|||
|
|
|
|||
|
|
**目标**: 构建生产版本并提交
|
|||
|
|
|
|||
|
|
**Flutter Web 构建**:
|
|||
|
|
```bash
|
|||
|
|
cd flutter_monisuo
|
|||
|
|
flutter build web --release --dart-define=ENV=prod
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Admin 构建**:
|
|||
|
|
```bash
|
|||
|
|
cd monisuo-admin
|
|||
|
|
pnpm build
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**Git 提交**:
|
|||
|
|
```bash
|
|||
|
|
git add .
|
|||
|
|
git commit -m "feat(模块): 功能描述
|
|||
|
|
|
|||
|
|
- 详细说明 1
|
|||
|
|
- 详细说明 2"
|
|||
|
|
git push origin main
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 目录结构
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
monisuo/
|
|||
|
|
├── .agents/skills/monisuo-dev/ # 本技能
|
|||
|
|
├── docs/
|
|||
|
|
│ └── features/ # Feature Spec 文档
|
|||
|
|
│ └── FEATURE_TEMPLATE.md # 模板
|
|||
|
|
├── flutter_monisuo/ # Flutter 前端
|
|||
|
|
├── monisuo-admin/ # Admin 后台
|
|||
|
|
└── tests/
|
|||
|
|
├── api/ # API 测试脚本
|
|||
|
|
│ └── test-template.sh # 测试模板
|
|||
|
|
└── e2e/ # 端到端测试
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 常用命令
|
|||
|
|
|
|||
|
|
### Flutter
|
|||
|
|
```bash
|
|||
|
|
flutter pub get # 安装依赖
|
|||
|
|
flutter run -d chrome # 开发模式
|
|||
|
|
flutter analyze # 代码检查
|
|||
|
|
flutter test # 运行测试
|
|||
|
|
flutter build web --release --dart-define=ENV=prod # 生产构建
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### Admin
|
|||
|
|
```bash
|
|||
|
|
pnpm install # 安装依赖
|
|||
|
|
pnpm dev # 开发模式
|
|||
|
|
pnpm build # 生产构建
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 测试
|
|||
|
|
```bash
|
|||
|
|
./tests/api/test-template.sh # 运行 API 测试
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 环境配置
|
|||
|
|
|
|||
|
|
| 环境 | ENV | API 地址 |
|
|||
|
|
|------|-----|----------|
|
|||
|
|
| 开发 | dev | http://localhost:5010 |
|
|||
|
|
| 生产 | prod | http://8.155.172.147:5010 |
|
|||
|
|
|
|||
|
|
## 最佳实践
|
|||
|
|
|
|||
|
|
1. **需求阶段**: 充分理解业务,明确验收标准
|
|||
|
|
2. **开发阶段**: 小步迭代,频繁提交,遵循规范
|
|||
|
|
3. **测试阶段**: 自动化测试优先,覆盖完整
|
|||
|
|
4. **部署阶段**: 使用生产配置,灰度发布
|
|||
|
|
|
|||
|
|
## 参考资源
|
|||
|
|
|
|||
|
|
- [Flutter 文档](https://flutter.dev/docs)
|
|||
|
|
- [Spring Boot 文档](https://spring.io/projects/spring-boot)
|
|||
|
|
- [Conventional Commits](https://www.conventionalcommits.org/)
|
|||
|
|
- [Clean Code 技能](~/.agents/skills/clean-code/SKILL.md)
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
**版本**: v1.0.0
|
|||
|
|
**创建日期**: 2026-03-23
|