docs: 更新团队分工

This commit is contained in:
龙大 2026-03-20 20:25:39 +08:00
parent 73dbc63e71
commit 074fddc687
1 changed files with 40 additions and 115 deletions

143
README.md
View File

@ -1,6 +1,6 @@
# 甲辰藏品管理系统 # 甲辰藏品管理系统
> 生肖纪念钞收藏管理系统 - 支持藏品管理、OCR识别、统计分析等功能 > 生肖纪念钞收藏管理系统
## 版本信息 ## 版本信息
@ -12,32 +12,20 @@
## 技术栈 ## 技术栈
### 后端 - **后端**: FastAPI + PostgreSQL + 阿里云OSS + 阿里云短信
- FastAPI + SQLAlchemy - **前端**: React + Vite + Tailwind CSS
- PostgreSQL 数据库 - **部署**: Nginx
- JWT 认证
- 阿里云 OSS 对象存储
- 阿里云短信服务
- 阿里云视觉智能 OCR
### 前端
- React + Vite
- 移动端适配
- 暗色主题
- Tailwind CSS
## 核心功能 ## 核心功能
| 功能 | 状态 | 说明 | - 用户管理(管理员/普通用户)
|------|------|------| - 藏品管理CRUD、多条件筛选
| 用户管理 | ✅ | 管理员/普通用户,角色权限 | - OCR识别阿里云视觉智能
| 藏品管理 | ✅ | CRUD支持多条件筛选 | - 统计分析
| OCR识别 | ✅ | 阿里云视觉智能,自动提取信息 | - 图片上传阿里云OSS
| 统计分析 | ✅ | 多维度数据统计 | - 短信验证码
| 图片上传 | ✅ | 阿里云OSS存储 | - 用户协议
| 短信验证码 | ✅ | 阿里云短信服务 | - 密码强度验证
| 用户协议 | ✅ | 注册需勾选协议 |
| 密码强度验证 | ✅ | 8位以上大小写数字 |
## 项目结构 ## 项目结构
@ -46,108 +34,48 @@ jiachenlong/
├── backend/ # FastAPI后端 ├── backend/ # FastAPI后端
│ ├── app/ │ ├── app/
│ │ ├── routers/ # API路由 │ │ ├── routers/ # API路由
│ │ │ ├── auth.py # 认证API
│ │ │ ├── collections.py # 藏品API
│ │ │ ├── ocr.py # OCR API
│ │ │ └── users.py # 用户API
│ │ ├── services/ # 业务服务 │ │ ├── services/ # 业务服务
│ │ │ ├── sms.py # 短信服务
│ │ │ └── oss.py # OSS服务
│ │ └── modules/ # 业务模块 │ │ └── modules/ # 业务模块
│ ├── config/ # 配置文件 │ └── config/
│ └── requirements.txt # Python依赖
├── frontend/ # React前端 ├── frontend/ # React前端
│ ├── src/ │ ├── src/pages/ # 页面组件
│ │ ├── pages/ # 页面组件
│ │ └── config/ # 配置
│ ├── static/ # 静态资源
│ └── dist/ # 构建产物 │ └── dist/ # 构建产物
└── config/ # 版本配置
├── config/ # 版本配置
└── static/ # 静态资源
``` ```
## 版本历史 ## 版本历史
| 版本 | 日期 | 说明 | | 版本 | 日期 | 说明 |
|------|------|------| |------|------|------|
| v1.2.2 | 2026-03-20 | 列表布局优化、颜色配置完善 | | v1.2.2 | 2026-03-20 | 列表布局优化 |
| v1.2.1 | 2026-03-20 | 密码强度验证、用户协议功能 | | v1.2.1 | 2026-03-20 | 密码强度验证、用户协议 |
| v1.2.0 | 2026-03-20 | 管理员查看用户藏品 | | v1.2.0 | 2026-03-20 | 管理员查看用户藏品 |
| v1.1.21 | 2026-03-19 | Nginx优化、OSS集成 | | v1.1.21 | 2026-03-19 | Nginx优化、OSS集成 |
| v1.1.0 | 2026-03-18 | 用户设置功能 | | v1.1.0 | 2026-03-18 | 用户设置功能 |
| v1.0.0 | 2026-03-16 | 初始版本 |
## 快速开始 ## 快速开始
### 后端启动
```bash ```bash
cd backend # 后端
pip install -r requirements.txt cd backend && pip install -r requirements.txt
python -m uvicorn app.main:app --reload python -m uvicorn app.main:app --reload
```
### 前端启动 # 前端
```bash cd frontend && npm install && npm run dev
cd frontend
npm install
npm run dev
```
### 构建生产版本
```bash
cd frontend
npm run build
``` ```
## API接口 ## API接口
### 认证接口 ### 认证
| 接口 | 方法 | 说明 | - POST /api/auth/register - 注册
|------|------|------| - POST /api/auth/login - 登录
| /api/auth/register | POST | 用户注册 | - GET /api/auth/me - 当前用户
| /api/auth/login | POST | 用户登录 |
| /api/auth/me | GET | 当前用户信息 |
| /api/auth/send-verification-code | POST | 发送验证码 |
| /api/auth/verify-code | POST | 验证验证码 |
### 藏品接口 ### 藏品
| 接口 | 方法 | 说明 | - GET /api/collections - 列表
|------|------|------| - POST /api/collections - 创建
| /api/collections | GET | 藏品列表 | - PUT /api/collections/{id} - 更新
| /api/collections | POST | 创建藏品 | - DELETE /api/collections/{id} - 删除
| /api/collections/{id} | GET | 藏品详情 |
| /api/collections/{id} | PUT | 更新藏品 |
| /api/collections/{id} | DELETE | 删除藏品 |
| /api/collections/stats | GET | 统计信息 |
### OCR接口
| 接口 | 方法 | 说明 |
|------|------|------|
| /api/ocr/recognize | POST | OCR识别 |
## 环境要求
- Python 3.9+
- Node.js 18+
- PostgreSQL 15+
## 配置说明
```bash
# 数据库
DATABASE_URL=postgresql://user:pass@host:5432/db
# JWT密钥
SECRET_KEY=your-secret-key
# 阿里云OSS
OSS_ACCESS_KEY_ID=xxx
OSS_ACCESS_KEY_SECRET=xxx
# 阿里云短信
SMS_ACCESS_KEY_ID=xxx
SMS_ACCESS_KEY_SECRET=xxx
SMS_SIGN_NAME=签名
SMS_TEMPLATE_CODE=模板Code
```
## 开发团队 ## 开发团队
@ -156,19 +84,16 @@ SMS_TEMPLATE_CODE=模板Code
| 产品负责人 | 酷博特 | 项目总负责 | | 产品负责人 | 酷博特 | 项目总负责 |
| 项目经理 | 龙大 | 项目整体管理 | | 项目经理 | 龙大 | 项目整体管理 |
| 开发 | 龙二 | 本地开发 | | 开发 | 龙二 | 本地开发 |
| 测试 | 龙A | 测试机1部署运维 | | 测试 | 龙A | A环境部署运维 |
| 测试 | 龙B | 测试机2部署运维 | | 测试 | 龙B | B环境部署运维 |
| 运维 | 龙运 | 监控/日志/备份 | | 运维 | 龙运 | 监控/日志/备份 |
| 运维 | 龙镜 | CI/CD和镜像管理 | | 运维 | 龙镜 | CI/CD和镜像管理 |
### 团队联系方式
- 飞书群:甲辰项目组
- 代码仓库http://47.253.189.47:3000/coolbot/jiachenlong
## 文档 ## 文档
- [部署手册](https://qcn9r1i8r51d.feishu.cn/docx/ZvEadXZ7XoxUtYxGLoIcMCfgn7g) - [部署手册](https://qcn9r1i8r51d.feishu.cn/docx/ZvEadXZ7XoxUtYxGLoIcMCfgn7g)
- [Git仓库](http://47.253.189.47:3000/coolbot/jiachenlong) - [Git仓库](http://47.253.189.47:3000/coolbot/jiachenlong)
--- ---
© 2026 甲辰收藏. All rights reserved. © 2026 甲辰收藏