Przeglądaj źródła

创建roo规则

yourname 8 miesięcy temu
rodzic
commit
ffe1ccb576
1 zmienionych plików z 47 dodań i 0 usunięć
  1. 47 0
      ROO_RULES.md

+ 47 - 0
ROO_RULES.md

@@ -0,0 +1,47 @@
+# 全栈应用开发规范
+
+## 项目结构
+
+```
+src/
+├── client/       # 前端代码 (React + Vite)
+├── server/       # 后端代码 (Hono + TypeORM)
+│   ├── api/      # API路由
+│   ├── migrations/ # 数据库迁移脚本
+│   ├── modules/  # 业务模块
+│   └── middleware/ # 中间件
+```
+
+## 技术栈
+
+### 前端
+- React 18
+- TypeScript (严格模式)
+- Vite 构建工具
+
+### 后端
+- Hono 框架
+- TypeORM (MySQL)
+- Redis (缓存/会话管理)
+
+## 开发规范
+
+1. **TypeScript严格模式**
+   - 启用所有严格类型检查选项
+   - 避免使用`any`类型
+
+2. **模块化组织**
+   - 按功能划分模块
+   - 每个模块包含:
+     - 实体定义
+     - 服务层
+     - 路由控制器
+
+3. **接口定义**
+   - 清晰的DTO(Data Transfer Object)定义
+   - 统一的API响应格式
+   - 完善的Swagger文档
+
+4. **数据库规范**
+   - 使用迁移脚本管理表结构变更
+   - 实体类与数据库表严格映射