AlphaFuturesProMax/docs/README.md

# 智能期货期权分析系统 - 文档中心

## 📢 重要更新 (2026-03-03)

**后端服务已实现！** 系统现已完整，包含用户认证、行情数据、技术指标、期权分析、AI智能分析等全部核心功能。

---

## 文档目录

| 文档 | 说明 |
|------|------|
| [01-项目概述.md](./01-项目概述.md) | 项目简介、核心功能、技术栈 |
| [02-开发文档.md](./02-开发文档.md) | 环境搭建、组件详解、数据类型 |
| [03-后续扩展计划.md](./03-后续扩展计划.md) | 待实现功能、开发排期 |
| [04-API接口文档.md](./04-API接口文档.md) | 接口规范、请求/响应示例 |
| [05-部署文档.md](./05-部署文档.md) | 部署方案、数据库设计 |
| [06-前端组件文档.md](./06-前端组件文档.md) | 组件Props、使用示例 |
| [07-TODO计划.md](./07-TODO计划.md) | 详细任务清单、开发排期 |
| [../PROJECT_SUMMARY.md](../PROJECT_SUMMARY.md) | **功能实现总结** |
| [../DEPLOY.md](../DEPLOY.md) | **部署指南** |

---

## 🚀 快速启动

### Docker方式 (推荐)

```bash
# 1. 进入项目目录
cd AlphaFuturesProMax

# 2. 启动所有服务
docker-compose up -d

# 3. 访问应用
# 前端: http://localhost
# API文档: http://localhost:3000/docs
```

### 手动部署

```bash
# 后端
cd app/server
npm install
npx prisma migrate deploy
npm run start:dev

# 前端
cd app
npm install
npm run dev
```

详细部署说明请参考 [DEPLOY.md](../DEPLOY.md)

---

## ✅ 已实现功能

### 后端服务 (NestJS + TypeScript)
- [x] **用户认证系统** - JWT认证、注册/登录/登出
- [x] **行情数据服务** - REST API + WebSocket实时推送
- [x] **技术指标引擎** - MACD, RSI, KDJ, BOLL, SAR, OBV, DMI, CCI, WR
- [x] **期权分析模块** - Black-Scholes定价、希腊值、波动率曲面
- [x] **AI智能分析** - OpenAI集成、趋势判断、交易建议
- [x] **热点事件管理** - 事件增删改查、影响分析
- [x] **自选股功能** - 自选管理、价格预警
- [x] **价格预警系统** - 定时检查、触发通知

### 前端功能
- [x] 市场概览仪表盘
- [x] 热点事件智能分析
- [x] 多周期品种筛选
- [x] K线技术分析 (MACD/成交量/MA)
- [x] 交易建议系统
- [x] 响应式布局
- [x] 深色主题
- [x] API服务封装

### 部署运维
- [x] Docker容器化
- [x] Docker Compose编排
- [x] PostgreSQL数据库
- [x] Redis缓存
- [x] Nginx反向代理

---

## 📡 API接口

### 认证
- `POST /api/v1/auth/register` - 注册
- `POST /api/v1/auth/login` - 登录
- `GET /api/v1/auth/profile` - 用户信息

### 行情
- `GET /api/v1/market/products` - 品种列表
- `GET /api/v1/market/products/:symbol/kline` - K线数据
- `GET /api/v1/market/overview` - 市场概览
- WebSocket: `ws://localhost:3000/market` - 实时推送

### 技术指标
- `GET /api/v1/indicators/:symbol` - 全部指标
- `GET /api/v1/indicators/:symbol/macd` - MACD
- `GET /api/v1/indicators/:symbol/rsi` - RSI
- `GET /api/v1/indicators/:symbol/bollinger` - 布林带

### 期权
- `POST /api/v1/options/pricing` - 期权定价
- `GET /api/v1/options/chain/:underlying` - 期权链
- `POST /api/v1/options/strategy/payoff` - 策略盈亏

### AI分析
- `GET /api/v1/ai/analyze/:symbol` - AI智能分析

### 更多
完整API文档请访问: `http://localhost:3000/docs`

---

## 📊 项目进度

```
整体进度: [████████████████████░░░░] 85%

前端UI:    [████████████████████░░░░] 85%
后端服务:  [████████████████████░░░░] 85%
数据接入:  [████████████████████░░░░] 85%
部署配置:  [████████████████████████] 100%
文档完善:  [████████████████████████] 95%
```

### 当前状态
- **已完成**: 完整后端服务、前端UI、Docker部署
- **待完善**: 前端接入真实API、交易信号系统

---

## 🏗️ 技术栈

### 后端
- **框架**: NestJS 10 + TypeScript
- **数据库**: PostgreSQL 15 + Prisma ORM
- **缓存**: Redis 7
- **认证**: JWT + Passport
- **文档**: Swagger/OpenAPI

### 前端
- **框架**: React 18 + TypeScript + Vite
- **样式**: Tailwind CSS 3.4 + shadcn/ui
- **图表**: ECharts 5.4
- **状态**: Zustand (推荐)

### 部署
- **容器**: Docker + Docker Compose
- **代理**: Nginx
- **CI/CD**: GitHub Actions (可选)

---

## 📁 项目结构

```
AlphaFuturesProMax/
├── app/                      # 前端
│   ├── src/
│   │   ├── components/       # UI组件
│   │   ├── services/         # API & WebSocket
│   │   └── ...
│   ├── Dockerfile
│   └── nginx.conf
│
├── app/server/               # 后端 (NestJS)
│   ├── src/
│   │   ├── auth/             # 认证模块
│   │   ├── market/           # 行情模块
│   │   ├── indicators/       # 技术指标
│   │   ├── options/          # 期权分析
│   │   ├── ai/               # AI分析
│   │   ├── events/           # 热点事件
│   │   ├── watchlist/        # 自选股
│   │   └── common/           # 公共模块
│   ├── prisma/
│   └── Dockerfile
│
├── docker-compose.yml        # Docker编排
├── DEPLOY.md                 # 部署指南
└── docs/                     # 文档目录
```

---

## 🎯 扩展建议

### 数据源接入
目前使用模拟数据，可接入：
- Wind/iFinD/Choice API
- 交易所官方API

### 新增功能
- 交易信号系统 (多指标共振)
- 量化策略回测引擎
- 管理后台
- 移动端APP

---

## 📄 许可证

MIT License

---

## 联系方式

如有问题或建议，欢迎反馈。