ci: 添加 Docker 构建和推送工作流

- 新增 Dockerfile 和 .dockerignore 文件
- 添加 Gitea 持续集成工作流,用于构建和推送 Docker 镜像
- 新增 .gitignore 文件,忽略构建和配置文件
- 添加项目结构和规范文档,包括 TypeScript、模块化、API、数据库等规范
- 新增前端和后端的基础代码结构
This commit is contained in:
D8D Developer
2025-06-11 09:35:39 +00:00
commit 71aaeb9424
70 changed files with 4170 additions and 0 deletions

25
.roo/rules/01-general.md Normal file
View File

@@ -0,0 +1,25 @@
# 基础规范
## 项目结构
```
src/
├── client/ # 前端代码 (React + Vite)
├── server/ # 后端代码 (Hono + TypeORM)
│ ├── api/ # API路由
│ ├── migrations/ # 数据库迁移脚本
│ ├── modules/ # 业务模块
│ └── middleware/ # 中间件
```
## 技术栈
### 前端
- React 18
- TypeScript (严格模式)
- Vite 构建工具
### 后端
- Hono 框架
- TypeORM (MySQL)
- Redis (缓存/会话管理)

View File

@@ -0,0 +1,5 @@
# TypeScript规范
1. **严格模式**
- 启用所有严格类型检查选项
- 避免使用`any`类型

8
.roo/rules/03-modules.md Normal file
View File

@@ -0,0 +1,8 @@
# 模块化规范
1. **模块组织**
- 按功能划分模块
- 每个模块包含:
- 实体定义
- 服务层
- 路由控制器

22
.roo/rules/04-api.md Normal file
View File

@@ -0,0 +1,22 @@
# 接口定义规范
1. **DTO定义**
- 必须包含`description`字段说明用途
- 必须包含`example`字段提供示例值
- 示例:
```typescript
export const CreateUserDto = z.object({
username: z.string().min(3).max(20).openapi({
example: 'john_doe',
description: '用户名, 3-20个字符'
}),
password: z.string().min(6).openapi({
example: 'password123',
description: '密码, 最少6位'
})
})
```
2. **API响应**
- 统一的API响应格式
- 完善的Swagger文档

View File

@@ -0,0 +1,5 @@
# 数据库规范
1. **迁移管理**
- 使用迁移脚本管理表结构变更
- 实体类与数据库表严格映射

View File

@@ -0,0 +1,18 @@
# 依赖注入规范
1. **依赖注入原则**
- 服务类必须通过构造函数注入依赖
- 禁止直接实例化全局对象(AppDataSource等)
- 示例:
```typescript
// Good - 通过构造函数注入
export class UserService {
constructor(private dataSource: DataSource) {}
}
// Bad - 使用全局实例
export class UserService {
constructor() {
this.repository = AppDataSource.getRepository(User);
}
}

180
.roo/rules/07-openapi.md Normal file
View File

@@ -0,0 +1,180 @@
# Hono OpenAPI规范
## 常见不规范问题
1. **路径参数问题**:
- ❌ 使用冒号定义路径参数: `/:id`
- ✅ 必须使用花括号: `/{id}`
2. **参数Schema缺失**:
- ❌ 未定义params Schema
- ✅ 必须定义并添加OpenAPI元数据
3. **参数获取方式**:
- ❌ 使用`c.req.param()`
- ✅ 必须使用`c.req.valid('param')`
4. **OpenAPI元数据**:
- ❌ 路径参数缺少OpenAPI描述
- ✅ 必须包含example和description
## 核心规范
### 1. 路由定义
- **路径参数**:
- 必须使用花括号 `{}` 定义 (例: `/{id}`)
- 必须定义 params Schema 并添加 OpenAPI 元数据:
```typescript
const GetParams = z.object({
id: z.string().openapi({
param: { name: 'id', in: 'path' },
example: '1',
description: '资源ID'
})
});
```
- 路由定义中必须包含 params 定义:
```typescript
request: { params: GetParams }
```
- 必须使用 `c.req.valid('param')` 获取路径参数
- **请求定义**:
```typescript
request: {
body: {
content: {
'application/json': { schema: YourZodSchema }
}
}
}
```
- **响应定义**:
```typescript
responses: {
200: {
description: '成功响应描述',
content: { 'application/json': { schema: SuccessSchema } }
},
400: {
description: '客户端错误',
content: { 'application/json': { schema: ErrorSchema } }
},
500: {
description: '服务器错误',
content: { 'application/json': { schema: ErrorSchema } }
}
}
```
- **路由示例**:
```typescript
const routeDef = createRoute({
method: 'post',
path: '/workspaces',
middleware: authMiddleware,
request: {
body: {
content: { 'application/json': { schema: CreateSchema } }
}
},
responses: {
200: { ... },
400: { ... },
500: { ... }
}
});
```
### 2. 错误处理
- 错误响应必须使用统一格式: `{ code: number, message: string }`
- 必须与OpenAPI定义完全一致
- 处理示例:
```typescript
try {
// 业务逻辑
} catch (error) {
return c.json({ code: 500, message: '操作失败' }, 500);
}
```
### 3. dataSource引入
- 示例:
```typescript
import { AppDataSource } from '@/server/data-source';
```
### 4. service初始化
- 示例:
```typescript
import { WorkspaceService } from '@/server/modules/workspaces/workspace.service';
const workspaceService = new WorkspaceService(AppDataSource);
### 5. 用户context获取
- 示例:
```typescript
const user = c.get('user');
```
- 注意: 确保 `c.get('user')` 已经在 `authMiddleware` 中设置
### 6. AuthContext引用
- 示例:
```typescript
import { AuthContext } from '@/server/types/context';
```
### 7. createRoute, OpenAPIHono 引入
- 示例:
```typescript
import { createRoute, OpenAPIHono } from '@hono/zod-openapi';
```
### 8. ErrorSchema 引入
- 示例:
```typescript
import { ErrorSchema } from '@/server/utils/errorHandler';
```
## 进阶规范
### 1. 路由聚合
当多个相关路由需要组合时:
1. **文件结构**:
- 拆分为独立文件 (`create.ts`, `list.ts` 等)
- 创建 `index.ts` 聚合所有子路由
2. **实现**:
```typescript
export default {
createRoute,
getRoute,
deleteRoute
}
```
3. **优势**:
- 保持模块化
- 简化维护
- 统一API入口
## 路由文件代码结构规范
+imports: 依赖导入
+serviceInit: 服务初始化
+paramsSchema: 路径参数定义
+responseSchema: 响应定义
+errorSchema: 错误定义
+routeDef: 路由定义
+app: 路由实例
## 完整示例
```typescript
// 路由实例
const app = new OpenAPIHono<AuthContext>().openapi(routeDef, async (c) => {
try {
// 业务逻辑
return c.json(result, 200);
} catch (error) {
return c.json({ code: 500, message: '操作失败' }, 500);
}
});
export default app;
```

45
.roo/rules/08-rpc.md Normal file
View File

@@ -0,0 +1,45 @@
# RPC 调用规范
## 核心原则
1. **类型安全**:
- 所有RPC调用必须基于OpenAPI定义的类型
- 客户端和服务端类型必须严格匹配
2. **一致性**:
- RPC调用路径必须与OpenAPI路由定义一致
- 错误处理格式必须统一
3. **api版本**:
- 所有RPC调用必须基于OpenAPI定义的版本
- 版本号必须与OpenAPI版本号一致
目前仅支持v1版本
示例:
```typescript
import { client } from '@/client/editor/api';
client.api.v1
## 客户端规范
### 1. 客户端初始化
```typescript
import { hc } from 'hono/client'
import ApiRoutes from '@/server/api';
export const client = hc<typeof ApiRoutes>('/', {
fetch: axiosFetch,
});
```
### 2. 方法调用
- 必须使用解构方式组织RPC方法
- 方法命名必须与OpenAPI路由定义一致
- 示例:
```typescript
const res = await client.api.v1.workspaces.templates.blank[':templateType'].$get({
param: {
templateType
}
});
if (res.status !== 200) {
throw new Error(res.message);
}
const templateInfo = await res.json();
```