xtraderClient/docs/README.md
2026-02-14 18:59:36 +08:00

71 lines
2.2 KiB
Markdown
Raw 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.

# PolyClientVuetify 开发文档
本目录包含项目各模块的详细开发文档,每个文件对应一份文档,说明其功能用途、使用方式及扩展方法。
## 功能实现状态
**[FEATURES.md](./FEATURES.md)**:已实现功能与未实现/Mock 功能清单,含实现优先级建议。
## 文档结构
```
docs/
├── README.md # 本索引文件
├── api/ # API 层
│ ├── request.md
│ ├── event.md
│ ├── category.md
│ ├── categoryIcons.md
│ ├── market.md
│ ├── user.md
│ ├── constants.md
│ └── mockEventList.md
├── stores/ # Pinia 状态
│ ├── user.md
│ └── counter.md
├── composables/ # 组合式函数
│ └── useSearchHistory.md
├── views/ # 页面视图
│ ├── Home.md
│ ├── Trade.md
│ ├── TradeDetail.md
│ ├── EventMarkets.md
│ ├── Login.md
│ └── Wallet.md
├── components/ # 可复用组件
│ ├── MarketCard.md
│ ├── TradeComponent.md
│ ├── OrderBook.md
│ ├── HorizontalProgressBar.md
│ ├── DepositDialog.md
│ └── WithdrawDialog.md
├── core/ # 核心入口与配置
│ ├── main.md
│ ├── App.md
│ ├── router.md
│ └── vuetify.md
└── config/ # 构建与工具配置
├── vite.md
└── package.md
```
## 技术栈概览
- **框架**Vue 3Composition API+ TypeScript
- **构建**Vite 7路径别名 `@/*``./src/*`
- **UI**Vuetify 4
- **状态**Pinia
- **路由**Vue Router 5
## 快速导航
| 模块 | 说明 |
|------|------|
| [API 层](./api/) | 请求封装、接口函数、类型定义 |
| [Stores](./stores/) | 全局状态管理 |
| [Composables](./composables/) | 组合式函数 |
| [Views](./views/) | 页面级视图,对应路由 |
| [Components](./components/) | 可复用 UI 组件 |
| [Core](./core/) | 入口、路由、插件 |
| [Config](./config/) | 构建与工具配置 |