Skip to content

feat(demo): one-command offline quickstart via make demo (P3.1)#65

Merged
Jcstack merged 1 commit into
mainfrom
feat/p3-quickstart-demo
Jun 26, 2026
Merged

feat(demo): one-command offline quickstart via make demo (P3.1)#65
Jcstack merged 1 commit into
mainfrom
feat/p3-quickstart-demo

Conversation

@Jcstack

@Jcstack Jcstack commented Jun 26, 2026

Copy link
Copy Markdown
Owner

Closes #57. Lowers onboarding friction with a zero-setup demo — no Docker, API keys, or network:

pip install -r requirements.txt
make demo

Runs the v2 backtest on a bundled sample dataset (scripts/sample/demo_ohlcv.csv, 160 synthetic bars) and prints a full performance report in one command. README gains a "30-second / no-setup" Quick Start step above the Docker path.

Verified make demo runs end-to-end offline. The full Docker stack (make up) is unchanged. Simulation-only; not investment advice.

Closes #57 (P3.1). Lowers onboarding friction with a zero-setup demo that runs
the v2 backtest on a bundled sample dataset — no Docker, API keys, or network:

- `make demo` → `scripts/backtest_v2 --csv scripts/sample/demo_ohlcv.csv --no-regime`,
  printing a full performance report in one command.
- scripts/sample/demo_ohlcv.csv: small committed synthetic OHLCV (160 bars).
- README: a "30-second / no-setup" Quick Start step above the Docker path.

Verified `make demo` runs end-to-end offline. The full Docker stack (`make up`)
is unchanged. Simulation-only; not investment advice.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Jcstack
Jcstack enabled auto-merge (squash) June 26, 2026 03:36
@Jcstack
Jcstack merged commit e7b9a34 into main Jun 26, 2026
5 of 6 checks passed
@Jcstack
Jcstack deleted the feat/p3-quickstart-demo branch June 26, 2026 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[P3.1] One-command quickstart (docker compose / make demo)

1 participant