docs: 更新README.md - v1.2.2版本说明
This commit is contained in:
龙大
parent
ef8b004a79
commit
221eeef464
224
README.md
224
README.md
|
|
@ -1,115 +1,183 @@
|
|||
# 甲辰藏品管理系统
|
||||
|
||||
**版本**: v1.0.0
|
||||
**代号**: 新生
|
||||
**发布日期**: 2026-03-16
|
||||
> 生肖纪念钞收藏管理系统 - 支持藏品管理、OCR识别、统计分析等功能
|
||||
|
||||
生肖纪念钞收藏管理系统 - 支持藏品管理、OCR 识别、统计分析等功能。
|
||||
## 版本信息
|
||||
|
||||
---
|
||||
| 项目 | 内容 |
|
||||
|------|------|
|
||||
| **版本** | v1.2.2 |
|
||||
| **代号** | 列表优化版本 |
|
||||
| **发布日期** | 2026-03-20 |
|
||||
|
||||
## 📁 项目结构
|
||||
## 技术栈
|
||||
|
||||
### 后端
|
||||
- FastAPI + SQLAlchemy
|
||||
- PostgreSQL 数据库
|
||||
- JWT 认证
|
||||
- 阿里云 OSS 对象存储
|
||||
- 阿里云短信服务
|
||||
- 阿里云视觉智能 OCR
|
||||
|
||||
### 前端
|
||||
- React + Vite
|
||||
- 移动端适配
|
||||
- 暗色主题
|
||||
- Tailwind CSS
|
||||
|
||||
## 核心功能
|
||||
|
||||
| 功能 | 状态 | 说明 |
|
||||
|------|------|------|
|
||||
| 用户管理 | ✅ | 管理员/普通用户，角色权限 |
|
||||
| 藏品管理 | ✅ | CRUD，支持多条件筛选 |
|
||||
| OCR识别 | ✅ | 阿里云视觉智能，自动提取信息 |
|
||||
| 统计分析 | ✅ | 多维度数据统计 |
|
||||
| 图片上传 | ✅ | 阿里云OSS存储 |
|
||||
| 短信验证码 | ✅ | 阿里云短信服务 |
|
||||
| 用户协议 | ✅ | 注册需勾选协议 |
|
||||
| 密码强度验证 | ✅ | 8位以上大小写数字 |
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
jiachenlong/
|
||||
├── backend/ # FastAPI 后端服务
|
||||
├── frontend/ # React 移动端前端
|
||||
├── static/ # 静态资源（图片、图标、字体）
|
||||
├── config/ # 配置文件
|
||||
├── docs/ # 文档
|
||||
├── scripts/ # 部署脚本
|
||||
└── README.md # 本文件
|
||||
├── 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
|
||||
|
||||
# 配置环境变量（修改数据库密码等）
|
||||
vi .env
|
||||
|
||||
# 启动服务
|
||||
python -m uvicorn app.main:app --port 3000 --host 0.0.0.0
|
||||
python -m uvicorn app.main:app --reload
|
||||
```
|
||||
|
||||
### 前端启动
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
|
||||
# 安装依赖
|
||||
npm install
|
||||
|
||||
# 开发模式
|
||||
npm run dev
|
||||
```
|
||||
|
||||
# 生产构建
|
||||
### 构建生产版本
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm run build
|
||||
```
|
||||
|
||||
### 配置文件
|
||||
## API接口
|
||||
|
||||
所有配置文件在 `config/` 目录：
|
||||
### 认证接口
|
||||
| 接口 | 方法 | 说明 |
|
||||
|------|------|------|
|
||||
| /api/auth/register | POST | 用户注册 |
|
||||
| /api/auth/login | POST | 用户登录 |
|
||||
| /api/auth/me | GET | 当前用户信息 |
|
||||
| /api/auth/send-verification-code | POST | 发送验证码 |
|
||||
| /api/auth/verify-code | POST | 验证验证码 |
|
||||
|
||||
- `config/VERSION` - 版本号配置
|
||||
- `config/docker-compose.yml` - Docker 部署配置
|
||||
- `.gitignore` - Git 忽略配置（根目录）
|
||||
### 藏品接口
|
||||
| 接口 | 方法 | 说明 |
|
||||
|------|------|------|
|
||||
| /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识别 |
|
||||
|
||||
所有静态资源在 `static/` 目录：
|
||||
## 环境要求
|
||||
|
||||
- `static/images/` - 图片资源（Logo、背景图等）
|
||||
- `static/icons/` - 图标资源（favicon、应用图标等）
|
||||
- `static/fonts/` - 字体文件
|
||||
- Python 3.9+
|
||||
- Node.js 18+
|
||||
- PostgreSQL 15+
|
||||
- Redis (可选)
|
||||
|
||||
## 配置说明
|
||||
|
||||
### 环境变量
|
||||
|
||||
```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 |
|
||||
| 测试 | 菜鸟测试 |
|
||||
| 运维 | 菜鸟生产 |
|
||||
|
||||
## 文档
|
||||
|
||||
- [部署手册](https://qcn9r1i8r51d.feishu.cn/docx/ZvEadXZ7XoxUtYxGLoIcMCfgn7g)
|
||||
- [Git仓库](http://47.253.189.47:3000/coolbot/jiachenlong)
|
||||
|
||||
---
|
||||
|
||||
## 📋 文档
|
||||
|
||||
所有文档都在 `docs/` 目录下：
|
||||
|
||||
- `docs/DEPLOYMENT_v1.0.0.md` - 部署指南
|
||||
- `docs/RELEASE_v1.0.0.md` - 发布说明
|
||||
- `docs/ERROR_CODES.md` - 错误码
|
||||
- `docs/部署手册.md` - 完整部署手册
|
||||
- `docs/BACKEND_SERVICE_GUIDE.md` - 后端服务指南
|
||||
- `docs/TEST_REPORT.md` - 测试报告
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ 技术栈
|
||||
|
||||
**后端**:
|
||||
- FastAPI + SQLAlchemy
|
||||
- PostgreSQL
|
||||
- JWT 认证
|
||||
- DashScope OCR
|
||||
|
||||
**前端**:
|
||||
- React + Vite
|
||||
- 移动端适配
|
||||
- 暗色主题
|
||||
|
||||
---
|
||||
|
||||
## 📊 核心功能
|
||||
|
||||
- ✅ 用户管理（管理员/普通用户）
|
||||
- ✅ 藏品管理（CRUD）
|
||||
- ✅ OCR 识别
|
||||
- ✅ 统计分析
|
||||
- ✅ 图片上传
|
||||
- ✅ 移动端适配
|
||||
|
||||
---
|
||||
|
||||
**开发团队**: 酷博特 + 菜鸟小 D 🤖
|
||||
© 2026 甲辰收藏. All rights reserved.
|
||||
|
|
|
|||
Loading…
Reference in New Issue