auto-sync: 2026-04-29 20:16:50

README.md

@@ -0,0 +1,67 @@
+# 三国量化交易平台（sanguo_vnpy）
+
+> 基于vn.py开源框架构建的量化交易全流程平台
+
+## 项目定位
+
+从0构建一个量化交易系统工作量巨大，因此我们选择**基于vnpy框架进行适配**，构建覆盖投研→策略开发→模拟回测→实盘交易的全流程平台。
+
+**核心原则**：尽量使用原生vnpy框架模块，不仿写不重写，只做适配和扩展。
+
+## 文档导航
+
+| 文档 | 说明 |
+|------|------|
+| [docs/01-requirements.md](docs/01-requirements.md) | 需求定义 |
+| [docs/02-architecture.md](docs/02-architecture.md) | 系统架构设计 |
+| [docs/03-detailed-design.md](docs/03-detailed-design.md) | 详细设计 |
+| [docs/04-deployment.md](docs/04-deployment.md) | 部署指南 |
+| [docs/05-user-manual.md](docs/05-user-manual.md) | 用户手册 |
+
+## 目录结构
+
+```
+sanguo_vnpy/
+├── docs/                    # 📖 项目文档（需求/架构/设计/部署/手册）
+├── src/                     # 🔥 平台核心代码
+│   ├── backtest-service/    #   vnpy 4.x 自动化回测服务
+│   ├── adapters/            #   vnpy适配层（数据适配器等）
+│   └── scripts/             #   启动脚本
+├── docker/                  # 🐳 Docker镜像构建
+│   ├── Dockerfile
+│   ├── entrypoint.sh
+│   └── requirements/
+├── config/                  # ⚙️ NAS多用户部署配置
+│   ├── nginx/               #   7用户反向代理配置
+│   └── systemd/             #   14个systemd服务文件
+├── deploy/                  # 🚀 部署工具
+│   └── nas/                 #   群晖NAS部署全流程
+├── research/                # 📚 技术调研文档
+│   ├── vnpy/                #   vnpy框架调研
+│   ├── nas/                 #   NAS部署调研
+│   ├── docker/              #   Docker相关调研
+│   └── jq_essence_articles/ #   聚宽精华文章
+├── data/                    # 💾 数据
+└── archive/                 # 📦 历史归档
+```
+
+## 快速开始
+
+详见 [docs/04-deployment.md](docs/04-deployment.md)
+
+## 技术栈
+
+- **框架**：vn.py 4.x（量化交易框架）
+- **服务化**：FastAPI + uvicorn（回测API服务）
+- **容器化**：Docker（群晖NAS部署）
+- **数据**：SQLite + akshare
+- **适配层**：继承vnpy BaseDatafeed/BaseGateway/CtaTemplate
+
+## 相关项目
+
+- [sanguo_quant_live](https://gitee.com/cfdaily/sanguo_quant_live) — 量化策略研究
+- [sanguo_mail](https://gitee.com/cfdaily/sanguo_mail) — Agent间邮件通信系统
+
+---
+
+*三国量化团队 · 姜维（平台总督）维护*