[项目管理] 添加开发规范和任务管理文档
Some checks failed
CI / Unit tests (push) Has been cancelled
CI / commit_lint (push) Has been cancelled

- 添加 Claude 项目开发指引 (.claude/project-instructions.md)
- 添加开发记录文档 (docs/DEVELOPMENT.md)
- 添加详细任务清单 (docs/TODO.md)
- 添加部署配置文档 (docs/DEPLOYMENT.md)

包含:开发流程规范、任务追踪、Git工作流、部署指南
This commit is contained in:
huangzhenpc
2025-12-29 23:02:49 +08:00
parent cb7c48bfa7
commit 91cbf92c13
4 changed files with 860 additions and 0 deletions

121
docs/DEVELOPMENT.md Normal file
View File

@@ -0,0 +1,121 @@
# 开发记录
## 项目信息
- **项目名称**Relay-SaaS
- **基于项目**one-api
- **开始日期**2025-12-29
- **Git 仓库**https://git.586vip.cn/oadmin/relay-saas.git
---
## 开发日志
### 2025-12-29
#### 项目初始化 ✅
**时间**:下午
**完成内容:**
1. 克隆 one-api 原始项目到本地
2. 深入探索代码结构:
- 令牌管理系统
- 额度计费系统
- 多机部署架构
3. 明确需求和技术方案
4. 编写详细的技术方案文档(`docs/SAAS-PLAN.md`
5. Git 仓库初始化和首次提交
**技术方案要点:**
- 采用完全独立部署架构
- 主系统统一管理渠道
- 月套餐令牌系统(日/周/月限额)
- 插件化开发保持可升级性
**Git 记录:**
```
cb7c48b - first commit: one-api base code + SAAS plan document
```
**配置完成:**
- ✅ WSL sudo 免密配置
- ✅ Git 用户配置
- ✅ Git 凭据存储
- ✅ 项目 Claude 配置
**下一步计划:**
- Phase 1: 基础架构开发(代理站点表和模型)
- 搭建开发环境Docker
---
## 待解决问题
### 环境问题
- [ ] WSL 网络代理配置(如需访问外网)
- [ ] Docker 安装(用于运行 one-api
### 技术问题
- [ ] 确定主从通信的认证机制细节
- [ ] 套餐额度重置的时区处理
---
## 技术笔记
### One-API 核心架构理解
**Token 验证流程:**
```
请求 → TokenAuth中间件 → ValidateUserToken →
检查状态/额度/IP/模型 → 通过
```
**计费流程:**
```
预扣费 → 调用上游API → 后结算(多退少补)
```
**关键文件:**
- `model/token.go` - Token模型和验证
- `relay/billing/billing.go` - 计费核心
- `middleware/auth.go` - 认证中间件
- `middleware/distributor.go` - 渠道分配
---
## 代码修改记录
### 本次开发周期:初始化
**新增文件:**
- `docs/SAAS-PLAN.md` - 完整技术方案文档
- `docs/DEVELOPMENT.md` - 本文件
- `docs/TODO.md` - 任务清单
- `.claude/project-instructions.md` - 项目开发指引
**修改文件:**
-
---
## 性能和优化记录
暂无
---
## Bug 记录
暂无
---
## 测试记录
暂无(项目初始阶段)
---
**文档维护**:每次开发完成后更新此文档
**最后更新**2025-12-29