Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,22 @@

All notable changes to this project will be documented in this file.

## [Unreleased] - 2026-05-20
## [Unreleased] - 2026-05-21

### Added
- Docs/Tooling: add `scripts/capture_frontend_previews.py` — a Playwright + Chromium driver that opens the live Docker frontend (`docker compose up -d api frontend`), runs a real `600519.SH` backtest in the Backtest Workbench, and writes `docs/assets/web-console-dashboard.png` and `docs/assets/web-console-backtest.png` straight from the running Vue console. Trailing blank padding is auto-cropped via Pillow.

Comment on lines +7 to +9
### Changed
- Docs: the README "Platform at a Glance" previews now come from **real sources only** — the two Web Console screenshots are captured from the live Vue frontend running under `docker compose`, and the backtest chart is the actual matplotlib output of `python unified_backtest_framework.py run --strategy macd --symbols 600519.SH --plot` (taken from `report/<run-id>/backtest_result.png`). No synthesized/mock images.
- Docs: rewrote the "Platform at a Glance" intro and image captions to name the real capture commands; redrew `docs/assets/architecture-overview.svg` to match the V6 layered architecture (Plugin SDK → SPI → Engines/Adapters → Runtime contexts → Kernel).
- Docs: rename the README "5-Second Preview" section to "Platform at a Glance" so the heading matches what the panel actually shows.

### Fixed
- Docs: repair the README "CI Status" badge URL — switched from the legacy `workflows/CI/badge.svg` shortcut (which never matched the workflow name `CI/CD Pipeline`) to the canonical `actions/workflows/ci.yml/badge.svg?branch=main` form and pointed the click target at the workflow page.

### Removed
- Docs/Tooling: delete `scripts/render_readme_preview.py` — the synthetic matplotlib renderer is superseded by real captures from the live frontend and CLI plot.
- Docs: drop obsolete preview assets `docs/assets/web-console-dashboard.svg`, `docs/assets/web-console-backtest.svg`, and `docs/assets/demo-workflow.gif` (superseded by the real PNG captures).

### Added
- V6 Phase 7 (distribution split): add packaging manifests for `quant-platform-core`, `quant-platform-sdk`, `quant-platform-adapters-cn`, `quant-platform-ml`, `quant-platform-web`, and `quant-platform-cli` under `packages/`, with matching `quant_platform_*` import facades.
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,26 @@

[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/)
[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
[![CI Status](https://github.com/magic-alt/stock/workflows/CI/badge.svg)](https://github.com/magic-alt/stock/actions)
[![CI Status](https://github.com/magic-alt/stock/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/magic-alt/stock/actions/workflows/ci.yml)
[![Code Coverage](https://codecov.io/gh/magic-alt/stock/branch/main/graph/badge.svg)](https://codecov.io/gh/magic-alt/stock)

面向 A 股的开源量化研究与回测平台:策略准入、回测报告、仿真交易、Web 控制台和实盘网关适配器一体化。

A-share quant research platform with strategy admission gates, backtesting, paper trading, a web console, and live gateway adapters.

**Current version**: V5.0.0 | **Updated**: 2026-05-19 | **Status**: local and container workflows ready
**Current version**: V5.0.0 | **Updated**: 2026-05-21 | **Status**: local and container workflows ready

## 5-Second Preview
## Platform at a Glance

![Architecture overview](docs/assets/architecture-overview.svg)
The two web-console previews below are **real screenshots of the running Vue frontend** (`docker compose up -d api frontend`), captured by [scripts/capture_frontend_previews.py](scripts/capture_frontend_previews.py) (Playwright + Chromium) after running an actual backtest on `600519.SH` through the API. The bottom chart is the **real CLI plot** produced by `python unified_backtest_framework.py run --strategy macd --symbols 600519.SH --plot`, taken straight from the run's `report/<run-id>/backtest_result.png`.

| Dashboard | Backtest workbench |
![V6 open-platform architecture](docs/assets/architecture-overview.svg)

| Dashboard view (live frontend) | Backtest workbench view (live frontend, real backtest) |
|---|---|
| ![Web console dashboard preview](docs/assets/web-console-dashboard.svg) | ![Web console backtest preview](docs/assets/web-console-backtest.svg) |
| ![Quant Platform dashboard — captured from the running Vue console](docs/assets/web-console-dashboard.png) | ![Backtest workbench — captured from the running Vue console after a real 600519.SH backtest](docs/assets/web-console-backtest.png) |

![Five-minute demo workflow](docs/assets/demo-workflow.gif)
![CLI backtest plot — 600519.SH with MA / Bollinger / RSI / MACD / KDJ panels and buy/sell markers, generated by `unified_backtest_framework.py run --plot`](docs/assets/backtest-preview.png)

## Why This Project

Expand Down
208 changes: 145 additions & 63 deletions docs/assets/architecture-overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/backtest-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/demo-workflow.gif
Binary file not shown.
Binary file added docs/assets/web-console-backtest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading