Files
DinQuant/quantdinger_vue/README.md
T

63 lines
1.7 KiB
Markdown
Raw Normal View History

2025-12-29 03:12:20 +08:00
# QuantDinger Web UI (Vue 2)
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
This is the QuantDinger frontend web UI built with **Vue 2** + **Ant Design Vue**. It connects to the Python backend (`backend_api_python/`) through HTTP APIs to provide charts, indicators, backtests, AI analysis, and strategy management.
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
> This UI is based on the open-source `ant-design-vue-pro` ecosystem, heavily adapted for QuantDinger.
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
## What you get
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
- **Dashboards**: summary views and operational panels
- **Indicator analysis**: Kline charts + indicator editing + backtest history
- **AI analysis**: multi-agent reports (optional LLM/search, configured on backend)
- **Trading assistant**: strategy lifecycle + positions/records (depending on backend capability)
- **Local auth**: login with backend-configured admin credentials
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
## Quick start (local development)
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
### Prerequisites
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
- Node.js 16+ recommended
- Backend running at `http://localhost:5000` (see `backend_api_python/README.md`)
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
### 1) Install dependencies
2025-12-29 03:06:49 +08:00
```bash
2025-12-29 03:12:20 +08:00
cd quantdinger_vue
npm install
2025-12-29 03:06:49 +08:00
```
2025-12-29 03:12:20 +08:00
### 2) Start dev server
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
```bash
npm run serve
2025-12-29 03:06:49 +08:00
```
2025-12-29 03:12:20 +08:00
Dev server runs at `http://localhost:8000`.
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
### 3) API proxy (important)
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
In dev mode, this project proxies `/api/*` to the backend:
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
- Proxy config: `quantdinger_vue/vue.config.js`
- Default target: `http://localhost:5000`
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
If your backend runs on a different host/port, update `vue.config.js` accordingly.
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
## Production build
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
```bash
npm run build
```
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
The output will be generated under `quantdinger_vue/dist/`.
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
## Notes
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
- **CORS**: when using the dev proxy, you typically dont need extra CORS config.
- **Login**: use the credentials defined in `backend_api_python/.env` (`ADMIN_USER` / `ADMIN_PASSWORD`).
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
## License
2025-12-29 03:06:49 +08:00
2025-12-29 03:12:20 +08:00
Apache License 2.0. See repository root `LICENSE`.
2025-12-29 03:06:49 +08:00