194 lines
4.9 KiB
Markdown
194 lines
4.9 KiB
Markdown
# 甲辰藏品管理系统
|
||
|
||
> 生肖纪念钞收藏管理系统 - 支持藏品管理、OCR识别、统计分析等功能
|
||
|
||
## 版本信息
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| **版本** | v1.2.2 |
|
||
| **代号** | 列表优化版本 |
|
||
| **发布日期** | 2026-03-20 |
|
||
|
||
## 技术栈
|
||
|
||
### 后端
|
||
- FastAPI + SQLAlchemy
|
||
- PostgreSQL 数据库
|
||
- JWT 认证
|
||
- 阿里云 OSS 对象存储
|
||
- 阿里云短信服务
|
||
- 阿里云视觉智能 OCR
|
||
|
||
### 前端
|
||
- React + Vite
|
||
- 移动端适配
|
||
- 暗色主题
|
||
- Tailwind CSS
|
||
|
||
## 核心功能
|
||
|
||
| 功能 | 状态 | 说明 |
|
||
|------|------|------|
|
||
| 用户管理 | ✅ | 管理员/普通用户，角色权限 |
|
||
| 藏品管理 | ✅ | CRUD，支持多条件筛选 |
|
||
| OCR识别 | ✅ | 阿里云视觉智能，自动提取信息 |
|
||
| 统计分析 | ✅ | 多维度数据统计 |
|
||
| 图片上传 | ✅ | 阿里云OSS存储 |
|
||
| 短信验证码 | ✅ | 阿里云短信服务 |
|
||
| 用户协议 | ✅ | 注册需勾选协议 |
|
||
| 密码强度验证 | ✅ | 8位以上大小写数字 |
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
jiachenlong/
|
||
├── backend/ # FastAPI后端
|
||
│ ├── app/
|
||
│ │ ├── routers/ # API路由
|
||
│ │ │ ├── auth.py # 认证API
|
||
│ │ │ ├── collections.py # 藏品API
|
||
│ │ │ ├── ocr.py # OCR API
|
||
│ │ │ └── users.py # 用户API
|
||
│ │ ├── services/ # 业务服务
|
||
│ │ │ ├── sms.py # 短信服务
|
||
│ │ │ └── oss.py # OSS服务
|
||
│ │ └── modules/ # 业务模块
|
||
│ ├── config/ # 配置文件
|
||
│ └── requirements.txt # Python依赖
|
||
│
|
||
├── frontend/ # React前端
|
||
│ ├── src/
|
||
│ │ ├── pages/ # 页面组件
|
||
│ │ │ ├── Login.jsx # 登录页
|
||
│ │ │ ├── List.jsx # 藏品列表
|
||
│ │ │ ├── Detail.jsx # 藏品详情
|
||
│ │ │ ├── Add.jsx # 添加藏品
|
||
│ │ │ └── OCR.jsx # OCR识别
|
||
│ │ └── config/ # 配置
|
||
│ ├── static/ # 静态资源
|
||
│ └── dist/ # 构建产物
|
||
│
|
||
├── config/ # 版本配置
|
||
└── static/ # 静态资源
|
||
```
|
||
|
||
## 版本历史
|
||
|
||
| 版本 | 日期 | 说明 |
|
||
|------|------|------|
|
||
| v1.2.2 | 2026-03-20 | 列表布局优化、颜色配置完善 |
|
||
| v1.2.1 | 2026-03-20 | 密码强度验证、用户协议功能 |
|
||
| v1.2.0 | 2026-03-20 | 管理员查看用户藏品 |
|
||
| v1.1.21 | 2026-03-19 | Nginx优化、OSS集成 |
|
||
| v1.1.0 | 2026-03-18 | 用户设置功能 |
|
||
| v1.0.0 | 2026-03-16 | 初始版本 |
|
||
|
||
## 快速开始
|
||
|
||
### 后端启动
|
||
|
||
```bash
|
||
cd backend
|
||
pip install -r requirements.txt
|
||
python -m uvicorn app.main:app --reload
|
||
```
|
||
|
||
### 前端启动
|
||
|
||
```bash
|
||
cd frontend
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
### 构建生产版本
|
||
|
||
```bash
|
||
cd frontend
|
||
npm run build
|
||
```
|
||
|
||
## API接口
|
||
|
||
### 认证接口
|
||
| 接口 | 方法 | 说明 |
|
||
|------|------|------|
|
||
| /api/auth/register | POST | 用户注册 |
|
||
| /api/auth/login | POST | 用户登录 |
|
||
| /api/auth/me | GET | 当前用户信息 |
|
||
| /api/auth/send-verification-code | POST | 发送验证码 |
|
||
| /api/auth/verify-code | POST | 验证验证码 |
|
||
|
||
### 藏品接口
|
||
| 接口 | 方法 | 说明 |
|
||
|------|------|------|
|
||
| /api/collections | GET | 藏品列表 |
|
||
| /api/collections | POST | 创建藏品 |
|
||
| /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
|
||
```
|
||
|
||
## 开发团队
|
||
|
||
| 角色 | 姓名 | 职责 |
|
||
|------|------|------|
|
||
| 产品负责人 | 酷博特 | 项目总负责 |
|
||
| 项目经理 | 龙大（菜鸟生产） | 项目整体管理 |
|
||
| 开发 | 菜鸟D | 本地开发 |
|
||
| 开发 | 菜鸟小D | 开发服务器 |
|
||
| 测试 | 菜鸟测试1 | 测试机1 |
|
||
| 测试 | 菜鸟测试2 | 测试机2 |
|
||
| 运维 | 甲辰运维 | 监控/日志/备份 |
|
||
| 运维 | 甲辰镜像管理员 | CI/CD和镜像管理 |
|
||
| 运维 | 甲辰应用1号 | 应用服务器1 |
|
||
| 运维 | 甲辰应用2号 | 应用服务器2 |
|
||
|
||
### 团队联系方式
|
||
|
||
- 飞书群：甲辰项目组
|
||
- 代码仓库：http://47.253.189.47:3000/coolbot/jiachenlong
|
||
|
||
## 文档
|
||
|
||
- [部署手册](https://qcn9r1i8r51d.feishu.cn/docx/ZvEadXZ7XoxUtYxGLoIcMCfgn7g)
|
||
- [Git仓库](http://47.253.189.47:3000/coolbot/jiachenlong)
|
||
|
||
---
|
||
|
||
© 2026 甲辰收藏. All rights reserved.
|