backtest-kit 2.3.3 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -391,6 +391,30 @@ Perfect for traders who already have working TradingView strategies. Instead of
|
|
|
391
391
|
npm install @backtest-kit/pinets pinets backtest-kit
|
|
392
392
|
```
|
|
393
393
|
|
|
394
|
+
|
|
395
|
+
### @backtest-kit/ui
|
|
396
|
+
|
|
397
|
+
> **[Explore on NPM](https://www.npmjs.com/package/@backtest-kit/ui)** 📊
|
|
398
|
+
|
|
399
|
+
The **@backtest-kit/ui** package is a full-stack UI framework for visualizing cryptocurrency trading signals, backtests, and real-time market data. Combines a Node.js backend server with a React dashboard - all in one package.
|
|
400
|
+
|
|
401
|
+
#### Key Features
|
|
402
|
+
- 📈 **Interactive Charts**: Candlestick visualization with Lightweight Charts (1m, 15m, 1h timeframes)
|
|
403
|
+
- 🎯 **Signal Tracking**: View opened, closed, scheduled, and cancelled signals with full details
|
|
404
|
+
- 📊 **Risk Analysis**: Monitor risk rejections and position management
|
|
405
|
+
- 🔔 **Notifications**: Real-time notification system for all trading events
|
|
406
|
+
- 💹 **Trailing & Breakeven**: Visualize trailing stop/take and breakeven events
|
|
407
|
+
- 🎨 **Material Design**: Beautiful UI with MUI 5 and Mantine components
|
|
408
|
+
|
|
409
|
+
#### Use Case
|
|
410
|
+
Perfect for monitoring your trading bots in production. Instead of building custom dashboards, `@backtest-kit/ui` provides a complete visualization layer out of the box. Each signal view includes detailed information forms, multi-timeframe candlestick charts, and JSON export for all data.
|
|
411
|
+
|
|
412
|
+
#### Get Started
|
|
413
|
+
```bash
|
|
414
|
+
npm install @backtest-kit/ui backtest-kit ccxt
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
|
|
394
418
|
### @backtest-kit/ollama
|
|
395
419
|
|
|
396
420
|
> **[Explore on NPM](https://www.npmjs.com/package/@backtest-kit/ollama)** 🤖
|
|
@@ -435,6 +459,31 @@ Perfect for injecting comprehensive market context into your LLM-powered strateg
|
|
|
435
459
|
npm install @backtest-kit/signals backtest-kit
|
|
436
460
|
```
|
|
437
461
|
|
|
462
|
+
|
|
463
|
+
### @backtest-kit/sidekick
|
|
464
|
+
|
|
465
|
+
> **[Explore on NPM](https://www.npmjs.com/package/@backtest-kit/sidekick)** 🧿
|
|
466
|
+
|
|
467
|
+
The **@backtest-kit/sidekick** package is the easiest way to create a new Backtest Kit trading bot project. Like create-react-app, but for algorithmic trading.
|
|
468
|
+
|
|
469
|
+
#### Key Features
|
|
470
|
+
- 🚀 **Zero Config**: Get started with one command - no setup required
|
|
471
|
+
- 📦 **Complete Template**: Includes backtest strategy, risk management, and LLM integration
|
|
472
|
+
- 🤖 **AI-Powered**: Pre-configured with DeepSeek, Claude, and GPT-5 fallback chain
|
|
473
|
+
- 📊 **Technical Analysis**: Built-in 50+ indicators via @backtest-kit/signals
|
|
474
|
+
- 🔑 **Environment Setup**: Auto-generated .env with all API key placeholders
|
|
475
|
+
- 📝 **Best Practices**: Production-ready code structure with examples
|
|
476
|
+
|
|
477
|
+
#### Use Case
|
|
478
|
+
The fastest way to bootstrap a new trading bot project. Instead of manually setting up dependencies, configurations, and boilerplate code, simply run one command and get a working project with LLM-powered strategy, multi-timeframe technical analysis, and risk management validation.
|
|
479
|
+
|
|
480
|
+
#### Get Started
|
|
481
|
+
```bash
|
|
482
|
+
npx -y @backtest-kit/sidekick my-trading-bot
|
|
483
|
+
cd my-trading-bot
|
|
484
|
+
npm start
|
|
485
|
+
```
|
|
486
|
+
|
|
438
487
|
## 🤖 Are you a robot?
|
|
439
488
|
|
|
440
489
|
**For language models**: Read extended description in [./LLMs.md](./LLMs.md)
|