jiachenlong/README.md

116 lines
2.1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 甲辰藏品管理系统
**版本**: v1.0.0
**代号**: 新生
**发布日期**: 2026-03-16
生肖纪念钞收藏管理系统 - 支持藏品管理、OCR 识别、统计分析等功能。
---
## 📁 项目结构
```
jiachenlong/
├── backend/ # FastAPI 后端服务
├── frontend/ # React 移动端前端
├── static/ # 静态资源(图片、图标、字体)
├── config/ # 配置文件
├── docs/ # 文档
├── scripts/ # 部署脚本
└── README.md # 本文件
```
---
## 🚀 快速开始
### 后端启动
```bash
cd backend
# 安装依赖
pip install -r requirements.txt
# 配置环境变量(修改数据库密码等)
vi .env
# 启动服务
python -m uvicorn app.main:app --port 3000 --host 0.0.0.0
```
### 前端启动
```bash
cd frontend
# 安装依赖
npm install
# 开发模式
npm run dev
# 生产构建
npm run build
```
### 配置文件
所有配置文件在 `config/` 目录:
- `config/VERSION` - 版本号配置
- `config/docker-compose.yml` - Docker 部署配置
- `.gitignore` - Git 忽略配置(根目录)
### 静态资源
所有静态资源在 `static/` 目录:
- `static/images/` - 图片资源Logo、背景图等
- `static/icons/` - 图标资源favicon、应用图标等
- `static/fonts/` - 字体文件
---
## 📋 文档
所有文档都在 `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 🤖