diff --git a/README.md b/README.md
index 5784378..a41069b 100644
--- a/README.md
+++ b/README.md
@@ -38,36 +38,119 @@
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
---
+## ๐ Table of Contents
+
+- [๐ Quick Start (2 Minutes)](#-quick-start-2-minutes)
+- [๐ Introduction](#-introduction)
+- [๐ธ Visual Tour](#-visual-tour)
+- [โจ Key Features](#-key-features)
+- [๐ Supported Exchanges & Brokers](#-supported-exchanges--brokers)
+- [๐๏ธ Architecture & Configuration](#๏ธ-architecture--configuration)
+- [๐ Documentation Index](#-documentation-index)
+- [๐ผ License & Commercial](#-license--commercial)
+- [๐ค Community & Support](#-community--support)
+
+---
+
+## ๐ Quick Start (2 Minutes)
+
+> **Only need**: [Docker](https://docs.docker.com/get-docker/) installed. Nothing else.
+
+```bash
+# 1. Clone
+git clone https://github.com/brokermr810/QuantDinger.git
+cd QuantDinger
+
+# 2. Configure (edit admin password & AI API key)
+cp backend_api_python/env.example backend_api_python/.env
+
+# 3. Launch!
+docker-compose up -d --build
+```
+
+> **Windows PowerShell**: use `Copy-Item backend_api_python\env.example -Destination backend_api_python\.env`
+
+๐ **Done!** Open **http://localhost:8888** | Login: `quantdinger` / `123456`
+
+
+๐ Key settings in backend_api_python/.env
+
+```ini
+# Required โ Change for production!
+ADMIN_USER=quantdinger
+ADMIN_PASSWORD=your_secure_password
+SECRET_KEY=your_random_secret_key
+
+# Optional โ Enable AI features (pick one)
+OPENROUTER_API_KEY=your_key # Recommended: 100+ models
+OPENAI_API_KEY=your_key # GPT-4o
+DEEPSEEK_API_KEY=your_key # Cost-effective
+GOOGLE_GEMINI_API_KEY=your_key # Gemini
+```
+
+
+
+
+๐ง Common Docker Commands
+
+```bash
+docker-compose ps # View service status
+docker-compose logs -f backend # View backend logs (real-time)
+docker-compose restart backend # Restart backend only
+docker-compose up -d --build # Rebuild & restart all
+docker-compose down # Stop all services
+```
+
+**Update to latest version:**
+```bash
+git pull && docker-compose up -d --build
+```
+
+**Backup & Restore database:**
+```bash
+docker exec quantdinger-db pg_dump -U quantdinger quantdinger > backup.sql
+cat backup.sql | docker exec -i quantdinger-db psql -U quantdinger quantdinger
+```
+
+**Custom port** โ create `.env` in project root:
+```ini
+FRONTEND_PORT=3000 # Default: 8888
+BACKEND_PORT=127.0.0.1:5001 # Default: 5000
+```
+
+
+
+---
+
## ๐ Introduction
-### What is QuantDinger?
+**QuantDinger** is a **self-hosted, privacy-first AI quantitative trading platform**. Your strategies, API keys, and trading data stay on **your own machine** โ not in someone else's cloud.
-QuantDinger is a **local-first, privacy-first, self-hosted quantitative trading infrastructure**. It runs on your own machine/server, providing **multi-user accounts backed by PostgreSQL** while keeping full control of your strategies, trading data, and API keys.
-
-### Why Local-First?
-
-Unlike SaaS platforms that lock your data and strategies in the cloud, QuantDinger runs locally. Your strategies, trading logs, API keys, and analysis results stay on your machine. No vendor lock-in, no data exfiltration.
-
-### Who is this for?
-
-QuantDinger is built for traders, researchers, and engineers who:
-- Value data sovereignty and privacy
-- Want transparent, auditable trading infrastructure
-- Prefer engineering over marketing
-- Need a complete workflow: data, analysis, backtesting, and execution
-
-### Core Value
-
-- **๐ Apache 2.0 Open Source (Backend)**: Permissive and commercial-friendly
-- **๐ Python-Native & Visual**: Write indicators in Python with AI assistance, visualize on built-in K-line charts
-- **๐ค AI-Loop Optimization**: AI analyzes backtest results to suggest parameter tuning, forming a closed optimization loop
-- **๐ Universal Market Access**: Crypto (Live), US Stocks (IBKR), Forex (MT5), Futures (Data/Notify)
-- **๐ณ Built-in Monetization**: Membership subscription, credit system, USDT on-chain payment
-- **โก Docker One-Click Deploy**: `docker-compose up -d` โ zero dependency, zero build, production-ready in 2 minutes
+| | |
+|---|---|
+| ๐ **Privacy-First** | Your API keys, strategies, and data never leave your server |
+| ๐ **Python-Native** | Write indicators in Python, visualize on K-line charts with AI assistance |
+| ๐ค **AI Co-Pilot** | Multi-agent analysis, backtest optimization, trading radar |
+| ๐ **Multi-Market** | Crypto (10+ exchanges), US Stocks (IBKR), Forex (MT5) |
+| ๐ณ **Monetization-Ready** | Membership, credits, USDT on-chain payment โ all built-in |
+| โก **One-Click Deploy** | `docker-compose up -d` โ production-ready in 2 minutes |
---
@@ -77,75 +160,15 @@ QuantDinger is built for traders, researchers, and engineers who:
- Click the video above to watch the QuantDinger project introduction
+ โถ๏ธ Click to watch the full project introduction
---
-## ๐ Documentation Index
-
-All detailed guides and tutorials are in the [`docs/`](docs/) folder. Click any link below to jump directly.
-
-### ๐ General
-
-| Document | Description |
-|----------|-------------|
-| [Changelog](docs/CHANGELOG.md) | Version history, new features, bug fixes, and migration notes |
-| [Multi-User Setup](docs/multi-user-setup.md) | PostgreSQL-based multi-user deployment guide |
-
-### ๐ Strategy Development
-
-| Document | Language |
-|----------|----------|
-| [Strategy Development Guide](docs/STRATEGY_DEV_GUIDE.md) | ๐บ๐ธ English |
-| [็ญ็ฅๅผๅๆๅ](docs/STRATEGY_DEV_GUIDE_CN.md) | ๐จ๐ณ ็ฎไฝไธญๆ |
-| [็ญ็ฅ้็ผๆๅ](docs/STRATEGY_DEV_GUIDE_TW.md) | ๐น๐ผ ็น้ซไธญๆ |
-| [ในใใฉใใธใผ้็บใฌใคใ](docs/STRATEGY_DEV_GUIDE_JA.md) | ๐ฏ๐ต ๆฅๆฌ่ช |
-| [์ ๋ต ๊ฐ๋ฐ ๊ฐ์ด๋](docs/STRATEGY_DEV_GUIDE_KO.md) | ๐ฐ๐ท ํ๊ตญ์ด |
-
-### ๐ Cross-Sectional Strategy
-
-| Document | Language |
-|----------|----------|
-| [Cross-Sectional Strategy Guide](docs/CROSS_SECTIONAL_STRATEGY_GUIDE_EN.md) | ๐บ๐ธ English |
-| [ๆช้ข็ญ็ฅๅผๅๆๅ](docs/CROSS_SECTIONAL_STRATEGY_GUIDE_CN.md) | ๐จ๐ณ ็ฎไฝไธญๆ |
-
-### ๐ฆ Broker Integration
-
-| Document | Description |
-|----------|-------------|
-| [IBKR Trading Guide](docs/IBKR_TRADING_GUIDE_EN.md) | Interactive Brokers (US Stocks) integration |
-| [MT5 Trading Guide (EN)](docs/MT5_TRADING_GUIDE_EN.md) | MetaTrader 5 (Forex) integration โ English |
-| [MT5 ไบคๆๆๅ (CN)](docs/MT5_TRADING_GUIDE_CN.md) | MetaTrader 5 (Forex) ้ๆๆๅ โ ไธญๆ |
-
-### ๐ OAuth Configuration
-
-| Document | Language |
-|----------|----------|
-| [OAuth Configuration (EN)](docs/OAUTH_CONFIG_EN.md) | ๐บ๐ธ Google & GitHub OAuth setup |
-| [OAuth ้
็ฝฎๆๅ (CN)](docs/OAUTH_CONFIG_CN.md) | ๐จ๐ณ Google & GitHub OAuth ้
็ฝฎ |
-
-### ๐ Notification Configuration
-
-| Channel | English | ไธญๆ |
-|---------|---------|------|
-| **Telegram** | [Setup Guide](docs/NOTIFICATION_TELEGRAM_CONFIG_EN.md) | [้
็ฝฎๆๅ](docs/NOTIFICATION_TELEGRAM_CONFIG_CH.md) |
-| **Email (SMTP)** | [Setup Guide](docs/NOTIFICATION_EMAIL_CONFIG_EN.md) | [้
็ฝฎๆๅ](docs/NOTIFICATION_EMAIL_CONFIG_CH.md) |
-| **SMS (Twilio)** | [Setup Guide](docs/NOTIFICATION_SMS_CONFIG_EN.md) | [้
็ฝฎๆๅ](docs/NOTIFICATION_SMS_CONFIG_CH.md) |
-
-### ๐ป Code Examples
-
-| File | Description |
-|------|-------------|
-| [docs/examples/](docs/examples/) | Python strategy code examples and templates |
-
----
-
## ๐ธ Visual Tour
๐บ๏ธ System Architecture Overview
-
A comprehensive view of QuantDinger's AI-powered research, backtesting, and automated trading capabilities.
@@ -153,7 +176,6 @@ All detailed guides and tutorials are in the [`docs/`](docs/) folder. Click any
๐ Professional Quant Dashboard
-
Real-time monitoring of market dynamics, assets, and strategy status.
@@ -163,31 +185,31 @@ All detailed guides and tutorials are in the [`docs/`](docs/) folder. Click any
๐ค AI Deep Research
- Multi-agent collaboration for market sentiment & technical analysis.
+ Multi-agent market sentiment & technical analysis
|
๐ฌ Smart Trading Assistant
- Natural language interface for instant market insights.
+ Natural language interface for market insights
|
- ๐ Interactive Indicator Analysis
- Rich library of technical indicators with drag-and-drop analysis.
+ ๐ Indicator Analysis
+ Technical indicators with drag-and-drop
|
- ๐ Python Strategy Gen
- Built-in editor with AI-assisted strategy coding.
+ ๐ AI Strategy Coding
+ AI-assisted Python strategy generation
|
๐ Portfolio Monitor
- Track positions, set alerts, and receive AI-powered analysis via Email/Telegram.
+ Track positions, set alerts, AI-powered analysis via Email/Telegram
|
@@ -197,188 +219,99 @@ All detailed guides and tutorials are in the [`docs/`](docs/) folder. Click any
## โจ Key Features
-### 1. Visual Python Strategy Workbench
-*Better than PineScript, Smarter than SaaS.*
+### ๐ Visual Python Strategy Workbench
-- **Python Native**: Write indicators and strategies in Python. Leverage the entire Python ecosystem (Pandas, Numpy, TA-Lib) instead of proprietary languages like PineScript.
-- **"Mini-TradingView" Experience**: Run your Python indicators directly on the built-in K-line charts. Visually debug buy/sell signals on historical data.
-- **AI-Assisted Coding**: Let the built-in AI write the complex logic for you. From idea to code in seconds.
+Write indicators in **Python** (not PineScript), run them on built-in K-line charts, and let AI write the complex logic for you. Full Python ecosystem: Pandas, Numpy, TA-Lib.
-### 2. Complete Trading Lifecycle
-*From Indicator to Execution, Seamlessly.*
+### ๐ Complete Trading Lifecycle
-1. **Indicator**: Define your market entry/exit signals.
-2. **Strategy Config**: Simplified creation with smart defaults (15min K-line, 5x leverage, market order). Advanced mode available for full customization.
-3. **Backtest & AI Optimization**: Run backtests, view rich performance metrics, and **let AI analyze the result to suggest improvements**.
-4. **Execution Mode**:
- - **Live Trading**:
- - **Cryptocurrency**: Direct API execution for 10+ exchanges (Binance, OKX, Bitget, Bybit, etc.)
- - **US Stocks**: Via Interactive Brokers (IBKR)
- - **Forex**: Via MetaTrader 5 (MT5)
- - **Signal Notification**: Send signals via Telegram, Discord, Email, SMS, or Webhook.
-5. **Risk Control**: Mandatory disclaimer acknowledgment before live trading. Market order mode by default for reliable execution.
+**Indicator โ Strategy โ Backtest โ AI Optimize โ Live Trade / Signal Notify**
-### 3. AI-Powered Analysis & Trading Radar
-*Fast, Accurate, Multi-Market Intelligence.*
+- Simplified strategy creation with smart defaults (15min K-line, 5x leverage, market order)
+- AI analyzes backtest results and suggests parameter improvements
+- Live trading on Crypto (10+ exchanges), US Stocks (IBKR), Forex (MT5)
+- Signal notifications via Telegram, Discord, Email, SMS, Webhook
-- **Fast Analysis Mode**: Single LLM call architecture for quick, accurate analysis
-- **AI Trading Opportunities Radar**: Auto-scans Crypto, US Stocks, and Forex markets every hour, displaying opportunities in a rolling carousel
-- **Quick Trade Panel (โก้ช็ตไบคๆ)**: Side-sliding trade panel โ see an AI signal or indicator opportunity, click "Trade Now" to instantly place an order without leaving the page. Supports market/limit orders, leverage, TP/SL price, and one-click position close.
-- **ATR-Based Trading Levels**: Stop-loss and take-profit recommendations based on technical analysis
-- **Analysis Memory**: Store analysis results for history review and continuous learning
-- **Strategic Integration**: AI analysis can serve as a "Market Filter" for your strategies
+### ๐ค AI-Powered Analysis
-### 4. Membership & Billing System
-*Built-in Monetization for Deployment.*
+- **Multi-Agent Analysis**: 5 parallel analysts + bull/bear debate + final trading decision
+- **AI Trading Radar**: Auto-scans Crypto/Stocks/Forex markets hourly
+- **Quick Trade Panel (โก)**: One-click trade from any analysis signal
+- **Memory-Augmented**: RAG-style local memory โ agents learn from past analyses
-- **Subscription Plans**: Monthly / Yearly / Lifetime tiers with configurable pricing
-- **Credit System**: Each plan includes credits; lifetime members receive monthly credit bonuses
-- **USDT On-Chain Payment** ๐ฐ: TRC20 scan-to-pay with HD Wallet (xpub) address derivation per order, automatic on-chain reconciliation via TronGrid API
-- **Admin Configuration**: All plan prices, credits, and payment settings configurable via System Settings
+### ๐ณ Built-in Monetization
-### 5. Indicator Community & VIP System
-*Share, Discover, and Trade Indicators.*
+- **Membership Plans**: Monthly / Yearly / Lifetime with credits
+- **USDT On-Chain Payment**: TRC20 scan-to-pay, HD Wallet address derivation, auto-reconciliation
+- **Indicator Marketplace**: Publish, buy, and sell Python indicators with credits
-- **Publish & Share**: Share your Python indicators with the community
-- **Credit-Based Purchase**: Buy premium indicators from other users with credits
-- **VIP Free Indicators**: Mark indicators as "VIP Free" โ VIP members can use them without spending credits
-- **Rating & Reviews**: Rate and review purchased indicators
-- **Live Performance Tracking**: Real-time performance stats aggregated from backtests and live trades
+### ๐ User Management & Security
-### 6. Universal Data Engine
+- Multi-user with PostgreSQL, role-based permissions
+- Google & GitHub OAuth, email verification
+- Cloudflare Turnstile captcha, rate limiting, demo mode
-QuantDinger provides a unified data interface across multiple markets:
+### ๐ง Multi-LLM Support
-- **Cryptocurrency**: Direct API connections for trading (10+ exchanges) and CCXT integration for market data (100+ sources)
-- **Stocks**: Yahoo Finance, Finnhub, Tiingo (US stocks)
-- **Futures/Forex**: OANDA and major futures data sources
-- **Proxy Support**: Built-in proxy configuration for restricted network environments
+| Provider | Models |
+|----------|--------|
+| **OpenRouter** | 100+ models (recommended) |
+| **OpenAI** | GPT-4o, GPT-4o-mini |
+| **Google Gemini** | Gemini 1.5 Flash/Pro |
+| **DeepSeek** | DeepSeek Chat |
+| **xAI Grok** | Grok Beta |
-### 7. Memory-Augmented Agents (Local RAG + Reflection Loop)
-
-QuantDinger's agents don't start from scratch every time. The backend includes a **local memory store** and an optional **reflection/verification loop**:
-
-- **What it is**: RAG-style experience retrieval injected into agent prompts (NOT model fine-tuning).
-- **Where it lives**: PostgreSQL database (shared with main data) or local files under `backend_api_python/data/memory/` (privacy-first).
+
+๐ Memory-Augmented Agent Architecture (Click to expand)
```mermaid
flowchart TB
- %% ===== ๐ Entry Layer =====
subgraph Entry["๐ API Entry"]
A["๐ก POST /api/analysis/multi"]
A2["๐ POST /api/analysis/reflect"]
end
-
- %% ===== โ๏ธ Service Layer =====
subgraph Service["โ๏ธ Service Orchestration"]
B[AnalysisService]
C[AgentCoordinator]
D["๐ Build Context
price ยท kline ยท news ยท indicators"]
end
-
- %% ===== ๐ค Multi-Agent Workflow =====
subgraph Agents["๐ค Multi-Agent Workflow"]
-
subgraph P1["๐ Phase 1 ยท Analysis (Parallel)"]
- E1["๐ MarketAnalyst
Technical"]
- E2["๐ FundamentalAnalyst
Fundamentals"]
- E3["๐ฐ NewsAnalyst
News & Events"]
- E4["๐ญ SentimentAnalyst
Market Mood"]
- E5["โ ๏ธ RiskAnalyst
Risk Assessment"]
+ E1["๐ MarketAnalyst"]
+ E2["๐ FundamentalAnalyst"]
+ E3["๐ฐ NewsAnalyst"]
+ E4["๐ญ SentimentAnalyst"]
+ E5["โ ๏ธ RiskAnalyst"]
end
-
- subgraph P2["๐ฏ Phase 2 ยท Debate (Parallel)"]
- F1["๐ BullResearcher
Bullish Case"]
- F2["๐ป BearResearcher
Bearish Case"]
+ subgraph P2["๐ฏ Phase 2 ยท Debate"]
+ F1["๐ BullResearcher"]
+ F2["๐ป BearResearcher"]
end
-
subgraph P3["๐น Phase 3 ยท Decision"]
- G["๐ฐ TraderAgent
Final Verdict โ BUY / SELL / HOLD"]
+ G["๐ฐ TraderAgent โ BUY / SELL / HOLD"]
end
-
end
-
- %% ===== ๐ง Memory Layer =====
subgraph Memory["๐ง PostgreSQL Memory Store"]
- M1[("market_analyst")]
- M2[("fundamental")]
- M3[("news_analyst")]
- M4[("sentiment")]
- M5[("risk_analyst")]
- M6[("bull_researcher")]
- M7[("bear_researcher")]
- M8[("trader_agent")]
+ M1[("agent memories")]
end
-
- %% ===== ๐ Reflection Loop =====
- subgraph Reflect["๐ Reflection Loop (Optional)"]
+ subgraph Reflect["๐ Reflection Loop"]
R[ReflectionService]
- RR[("reflection_records.db")]
W["โฐ ReflectionWorker"]
end
-
- %% ===== Main Flow =====
A --> B --> C --> D
D --> P1 --> P2 --> P3
-
- %% ===== Memory Read/Write =====
- E1 <-.-> M1
- E2 <-.-> M2
- E3 <-.-> M3
- E4 <-.-> M4
- E5 <-.-> M5
- F1 <-.-> M6
- F2 <-.-> M7
- G <-.-> M8
-
- %% ===== Reflection Flow =====
- C --> R --> RR
- W --> RR
- W -.->|"verify + learn"| M8
- A2 -.->|"manual review"| M8
+ Agents <-.-> M1
+ C --> R
+ W -.->|"verify + learn"| M1
```
-### 8. Multi-LLM Provider Support
-
-| Provider | Features |
-|----------|----------|
-| **OpenRouter** | Multi-model gateway (default), 100+ models |
-| **OpenAI** | GPT-4o, GPT-4o-mini |
-| **Google Gemini** | Gemini 1.5 Flash/Pro |
-| **DeepSeek** | DeepSeek Chat (cost-effective) |
-| **xAI Grok** | Grok Beta |
-
-Simply configure your preferred provider's API key in `.env`. The system auto-detects available providers.
-
-### 9. User Management & Security
-
-- **Multi-User Support**: PostgreSQL-backed user accounts with role-based permissions
-- **OAuth Login**: Google and GitHub OAuth integration
-- **Email Verification**: Registration and password reset via email codes
-- **Security Features**: Cloudflare Turnstile captcha, IP/account rate limiting
-- **Demo Mode**: Read-only mode for public demonstrations
-
-### 10. Strategy Runtime
-
-- **Thread-Based Executor**: Independent thread pool for strategy execution
-- **Auto-Restore**: Resumes running strategies after system restarts
-- **Market Order Default**: Prioritizes execution reliability over price optimization
-- **Order Queue**: Background worker for order execution
-
-### 11. Tech Stack
-
-- **Backend**: Python (Flask) + PostgreSQL + Redis (optional)
-- **Frontend**: Pre-built (Ant Design Vue + KlineCharts/ECharts)
-- **Payment**: USDT TRC20 on-chain (HD Wallet xpub derivation + TronGrid API)
-- **Mobile**: Vue 3 + Capacitor (Android / iOS) โ see `QuantDinger-Mobile/`
-- **Deployment**: Docker Compose (one-click, zero build)
-- **Current Version**: V2.2.1 ([Changelog](docs/CHANGELOG.md))
+
---
## ๐ Supported Exchanges & Brokers
-### Cryptocurrency Exchanges (Direct API)
+### Cryptocurrency (Direct API Trading)
| Exchange | Markets |
|:--------:|:---------|
@@ -386,292 +319,186 @@ Simply configure your preferred provider's API key in `.env`. The system auto-de
| OKX | Spot, Perpetual, Options |
| Bitget | Spot, Futures, Copy Trading |
| Bybit | Spot, Linear Futures |
-| Coinbase Exchange | Spot |
+| Coinbase | Spot |
| Kraken | Spot, Futures |
| KuCoin | Spot, Futures |
| Gate.io | Spot, Futures |
| Bitfinex | Spot, Derivatives |
-### Traditional Brokers
+### Traditional Brokers & Markets
-| Broker | Markets | Platform |
-|:------:|:--------|:---------|
-| **Interactive Brokers (IBKR)** | US Stocks | TWS / IB Gateway |
-| **MetaTrader 5 (MT5)** | Forex | MT5 Terminal |
-
-### Supported Markets
-
-| Market Type | Data Sources | Trading |
-|-------------|--------------|---------|
-| **Cryptocurrency** | Binance, OKX, Bitget, + 100 exchanges | โ
Full support |
-| **US Stocks** | Yahoo Finance, Finnhub, Tiingo | โ
Via IBKR |
-| **Forex** | Finnhub, OANDA | โ
Via MT5 |
-| **Futures** | Exchange APIs | โก Data only |
+| Market | Broker/Source | Trading |
+|--------|--------------|---------|
+| **US Stocks** | Interactive Brokers (IBKR), Yahoo Finance, Finnhub | โ
Via IBKR |
+| **Forex** | MetaTrader 5 (MT5), OANDA | โ
Via MT5 |
+| **Futures** | Exchange APIs | โก Data + Notify |
---
-### Multi-Language Support
-
-
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-
-
-All UI elements, error messages, and documentation are fully translated. Language is auto-detected based on browser settings or can be manually switched in the app.
-
----
-
-## ๐ Quick Start (Docker One-Click Deploy)
-
-> **Prerequisites**: Docker & Docker Compose installed.
-> No Node.js, no Python environment needed โ everything runs in containers.
-
-### 1. Clone & Configure
-
-```bash
-git clone https://github.com/brokermr810/QuantDinger.git
-cd QuantDinger
-```
-
-### 2. Set Up Environment
-
-```bash
-# Copy the environment template
-cp backend_api_python/env.example backend_api_python/.env
-```
-
-> **Windows PowerShell**:
-> ```powershell
-> Copy-Item backend_api_python\env.example -Destination backend_api_python\.env
-> ```
-
-Edit `backend_api_python/.env` with your settings:
-
-```ini
-# Required โ Change these for production!
-ADMIN_USER=quantdinger
-ADMIN_PASSWORD=your_secure_password
-SECRET_KEY=your_random_secret_key
-
-# Optional โ Enable AI features
-OPENROUTER_API_KEY=your_openrouter_key
-# or
-OPENAI_API_KEY=your_openai_key
-```
-
-### 3. Launch
-
-```bash
-docker-compose up -d --build
-```
-
-**That's it!** ๐ Wait about 30 seconds for all services to start.
-
-| Service | URL |
-|---------|-----|
-| **Frontend UI** | http://localhost:8888 |
-| Backend API | http://localhost:5000 (internal) |
-| PostgreSQL | localhost:5432 (internal) |
-
-Default login: `quantdinger` / `123456` (change in `.env` for production).
-
-### Common Docker Commands
-
-```bash
-docker-compose ps # View service status
-docker-compose logs -f backend # View backend logs (real-time)
-docker-compose logs -f frontend # View frontend/nginx logs
-docker-compose restart backend # Restart backend only
-docker-compose up -d --build # Rebuild & restart all
-docker-compose down # Stop all services
-```
-
-### Update to Latest Version
-
-```bash
-git pull
-docker-compose up -d --build
-```
-
-### Backup & Restore
-
-```bash
-# Backup database
-docker exec quantdinger-db pg_dump -U quantdinger quantdinger > backup_$(date +%Y%m%d).sql
-
-# Restore database
-cat backup.sql | docker exec -i quantdinger-db psql -U quantdinger quantdinger
-```
-
-### Custom Port
-
-Create a `.env` file in the project root to override docker-compose defaults:
-
-```ini
-FRONTEND_PORT=3000 # Change frontend port (default: 8888)
-BACKEND_PORT=127.0.0.1:5001 # Change backend port (default: 5000)
-DB_PORT=127.0.0.1:5433 # Change database port (default: 5432)
-```
-
----
-
-## ๐๏ธ Architecture
+## ๐๏ธ Architecture & Configuration
```text
-โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
-โ Docker Compose โ
-โ โ
-โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
-โ โ frontend (Nginx) โ โ
-โ โ Pre-built static files โ โ
-โ โ โ :8888 โ โ
-โ โโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโ โ
-โ โ /api/* proxy โ
-โ โผ โ
-โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
-โ โ backend (Python/Flask) โ โ
-โ โ API + AI + Strategy Runtime โ โ
-โ โ โ :5000 โ โ
-โ โโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโ โ
-โ โ โ
-โ โโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโ โ
-โ โ postgres (PostgreSQL 16) โ โ
-โ โ Users, Orders, Strategies, ... โ โ
-โ โ โ :5432 โ โ
-โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
-โ โ
-โ External connections: โ
-โ โโ LLM APIs (OpenRouter/OpenAI/...) โ
-โ โโ Exchange APIs (Binance/OKX/...) โ
-โ โโ TronGrid API (USDT payment) โ
-โ โโ Data providers (Yahoo/Finnhub/...) โ
-โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
+โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
+โ Docker Compose โ
+โ โ
+โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
+โ โ frontend (Nginx) โ :8888 โ โ
+โ โโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโ โ
+โ โ /api/* proxy โ
+โ โโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโ โ
+โ โ backend (Flask) โ :5000 โ โ
+โ โโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโ โ
+โ โโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโ โ
+โ โ postgres (PG 16) โ :5432 โ โ
+โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
+โ โ
+โ External: LLM APIs ยท Exchanges ยท โ
+โ TronGrid ยท Data providers โ
+โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
```
### Repository Layout
```text
QuantDinger/
-โโโ backend_api_python/ # ๐ Backend API (Open Source)
-โ โโโ app/
-โ โ โโโ routes/ # API endpoints (user, billing, strategy, ...)
-โ โ โโโ services/ # Business logic (trading, payment, AI, ...)
-โ โ โโโ data_sources/ # Market data providers
-โ โ โโโ utils/ # Helpers (DB, auth, etc.)
+โโโ backend_api_python/ # ๐ Backend (Open Source, Apache 2.0)
+โ โโโ app/routes/ # API endpoints
+โ โโโ app/services/ # Business logic (AI, trading, payment)
โ โโโ migrations/init.sql # Database schema
-โ โโโ env.example # โ๏ธ Configuration template โ copy to .env
-โ โโโ Dockerfile # Backend container image
-โ โโโ run.py # Entrypoint
-โ
+โ โโโ env.example # โ๏ธ Config template โ copy to .env
+โ โโโ Dockerfile
โโโ frontend/ # ๐จ Frontend (Pre-built)
-โ โโโ dist/ # Compiled static files (HTML/JS/CSS)
-โ โโโ Dockerfile # Nginx container image
-โ โโโ nginx.conf # Nginx config (SPA + API proxy)
-โ โโโ VERSION # Frontend version tracker
-โ
-โโโ docs/ # ๐ Documentation & Guides
-โ โโโ CHANGELOG.md # Version history
-โ โโโ screenshots/ # UI screenshots
-โ โโโ *.md # Strategy, broker, notification guides
-โ
+โ โโโ dist/ # Static files (HTML/JS/CSS)
+โ โโโ Dockerfile # Nginx image
+โ โโโ nginx.conf # SPA routing + API proxy
+โโโ docs/ # ๐ Guides & tutorials
โโโ docker-compose.yml # ๐ณ One-click deployment
-โโโ LICENSE # Apache License 2.0
-โโโ TRADEMARKS.md # Trademark policy
-โโโ SECURITY.md # Security policy
-โโโ CONTRIBUTING.md # Contribution guide
-โโโ CODE_OF_CONDUCT.md # Code of conduct
+โโโ LICENSE # Apache 2.0
```
----
+
+โ๏ธ Configuration Reference (.env)
-### Configuration (.env)
+Use `backend_api_python/env.example` as template:
-Use `backend_api_python/env.example` as a template. Key settings:
-
-| Category | Variables |
+| Category | Key Variables |
|----------|-----------|
| **Auth** | `SECRET_KEY`, `ADMIN_USER`, `ADMIN_PASSWORD` |
| **Database** | `DATABASE_URL` (PostgreSQL connection string) |
-| **AI / LLM** | `LLM_PROVIDER`, `OPENROUTER_API_KEY`, `OPENAI_API_KEY`, etc. |
-| **OAuth** | `GOOGLE_CLIENT_ID`, `GITHUB_CLIENT_ID`, etc. |
+| **AI / LLM** | `LLM_PROVIDER`, `OPENROUTER_API_KEY`, `OPENAI_API_KEY` |
+| **OAuth** | `GOOGLE_CLIENT_ID`, `GITHUB_CLIENT_ID` |
| **Security** | `TURNSTILE_SITE_KEY`, `ENABLE_REGISTRATION` |
-| **Order Execution** | `ORDER_MODE` (market/maker), `MAKER_WAIT_SEC` |
-| **Membership** | `MEMBERSHIP_MONTHLY_PRICE_USD`, `MEMBERSHIP_MONTHLY_CREDITS`, `MEMBERSHIP_YEARLY_PRICE_USD`, etc. |
-| **USDT Payment** | `USDT_PAY_ENABLED`, `USDT_TRC20_XPUB`, `TRONGRID_API_KEY`, `USDT_ORDER_EXPIRE_MINUTES` |
+| **Membership** | `MEMBERSHIP_MONTHLY_PRICE_USD`, `MEMBERSHIP_MONTHLY_CREDITS` |
+| **USDT Payment** | `USDT_PAY_ENABLED`, `USDT_TRC20_XPUB`, `TRONGRID_API_KEY` |
| **Proxy** | `PROXY_PORT` or `PROXY_URL` |
| **Workers** | `ENABLE_PENDING_ORDER_WORKER`, `ENABLE_PORTFOLIO_MONITOR` |
----
+
-### API
+
+๐ API Endpoints
-The backend provides REST endpoints for login, market data, indicators, backtesting, strategies, AI analysis, and billing.
-
-- Health: `GET /api/health`
-- Auth: `POST /api/user/login`, `GET /api/user/info`
-- Billing: `GET /api/billing/plans`, `POST /api/billing/usdt/create-order`
+| Endpoint | Description |
+|----------|-------------|
+| `GET /api/health` | Health check |
+| `POST /api/user/login` | User authentication |
+| `GET /api/user/info` | Current user info |
+| `GET /api/billing/plans` | Membership plans |
+| `POST /api/billing/usdt/create-order` | Create USDT payment order |
For the full route list, see `backend_api_python/app/routes/`.
+
+
---
-### License
+## ๐ Documentation Index
-Licensed under the **Apache License 2.0**. See `LICENSE`.
+All detailed guides are in the [`docs/`](docs/) folder:
-> **Note**: The frontend UI is provided as pre-built files. The backend source code is fully open under Apache 2.0.
+### Getting Started
+
+| Document | Description |
+|----------|-------------|
+| [Changelog](docs/CHANGELOG.md) | Version history & migration notes |
+| [Multi-User Setup](docs/multi-user-setup.md) | PostgreSQL multi-user deployment |
+
+### Strategy Development
+
+| Guide | ๐บ๐ธ EN | ๐จ๐ณ CN | ๐น๐ผ TW | ๐ฏ๐ต JA | ๐ฐ๐ท KO |
+|-------|--------|--------|--------|--------|--------|
+| **Strategy Dev** | [EN](docs/STRATEGY_DEV_GUIDE.md) | [CN](docs/STRATEGY_DEV_GUIDE_CN.md) | [TW](docs/STRATEGY_DEV_GUIDE_TW.md) | [JA](docs/STRATEGY_DEV_GUIDE_JA.md) | [KO](docs/STRATEGY_DEV_GUIDE_KO.md) |
+| **Cross-Sectional** | [EN](docs/CROSS_SECTIONAL_STRATEGY_GUIDE_EN.md) | [CN](docs/CROSS_SECTIONAL_STRATEGY_GUIDE_CN.md) | | | |
+| **Code Examples** | [examples/](docs/examples/) | | | | |
+
+### Broker & Integration
+
+| Guide | English | ไธญๆ |
+|-------|---------|------|
+| **IBKR (US Stocks)** | [Guide](docs/IBKR_TRADING_GUIDE_EN.md) | โ |
+| **MT5 (Forex)** | [Guide](docs/MT5_TRADING_GUIDE_EN.md) | [ๆๅ](docs/MT5_TRADING_GUIDE_CN.md) |
+| **OAuth (Google/GitHub)** | [Guide](docs/OAUTH_CONFIG_EN.md) | [ๆๅ](docs/OAUTH_CONFIG_CN.md) |
+
+### Notifications
+
+| Channel | English | ไธญๆ |
+|---------|---------|------|
+| **Telegram** | [Setup](docs/NOTIFICATION_TELEGRAM_CONFIG_EN.md) | [้
็ฝฎ](docs/NOTIFICATION_TELEGRAM_CONFIG_CH.md) |
+| **Email (SMTP)** | [Setup](docs/NOTIFICATION_EMAIL_CONFIG_EN.md) | [้
็ฝฎ](docs/NOTIFICATION_EMAIL_CONFIG_CH.md) |
+| **SMS (Twilio)** | [Setup](docs/NOTIFICATION_SMS_CONFIG_EN.md) | [้
็ฝฎ](docs/NOTIFICATION_SMS_CONFIG_CH.md) |
+
+---
+
+## ๐ผ License & Commercial
+
+### Open Source License
+
+Backend source code is licensed under **Apache License 2.0**. See `LICENSE`.
+
+The frontend UI is provided as **pre-built files**. Trademark rights (name/logo/branding) are governed separately โ see `TRADEMARKS.md`.
+
+### ๐ Free Source Code for Non-Profit & Education
+
+If you are a **university**, **research institution**, **non-profit**, **community group**, or **educational program**, you can apply for **free authorization and full frontend source code**:
+
+- ๐ซ Universities & academic research
+- ๐ Open-source communities & developer groups
+- ๐ค Non-profit & public welfare organizations
+- ๐ Educational programs & student hackathons
+
+### ๐ผ Commercial License
+
+For **commercial use**, purchase a license to get:
+
+- **Full frontend source code** + future updates
+- **Branding authorization** โ modify name/logo/copyright as agreed
+- **Operations support** โ deployment, upgrades, incident response
+- **Consulting** โ architecture review, performance tuning
+
+### ๐ฌ Contact
+
+| Channel | Link |
+|---------|------|
+| **Telegram** | [t.me/worldinbroker](https://t.me/worldinbroker) |
+| **Email** | [brokermr810@gmail.com](mailto:brokermr810@gmail.com) |
---
## ๐ค Community & Support
-- **Contributing**: [Contributing Guide](CONTRIBUTING.md) ยท [Contributors](CONTRIBUTORS.md)
-- **Telegram**: [QuantDinger Group](https://t.me/quantdinger)
-- **Discord**: [Join Server](https://discord.gg/tyx5B6TChr)
-- **๐บ Video Demo**: [Project Introduction](https://youtu.be/HPTVpqL7knM)
-- **YouTube**: [@quantdinger](https://youtube.com/@quantdinger)
-- **Email**: [brokermr810@gmail.com](mailto:brokermr810@gmail.com)
-- **GitHub Issues**: [Report bugs / Request features](https://github.com/brokermr810/QuantDinger/issues)
+
+ 
+ 
+ 
+
+
+- [Contributing Guide](CONTRIBUTING.md) ยท [Contributors](CONTRIBUTORS.md)
+- [Report Bugs / Request Features](https://github.com/brokermr810/QuantDinger/issues)
+- Email: [brokermr810@gmail.com](mailto:brokermr810@gmail.com)
---
-## ๐ผ Commercial License & Sponsorship
-
-QuantDinger is licensed under **Apache License 2.0** (code). However, **Apache 2.0 does NOT grant trademark rights**. Our branding assets (name/logo) are protected as trademarks and are governed separately from the code license:
-
-- **Copyright/Attribution**: You must keep required copyright and license notices (including any NOTICE/attribution in the repo and in the UI where applicable).
-- **Trademarks (Name/Logo/Branding)**: Without permission, you may not modify QuantDinger branding (name/logo/UI brand), or use it to imply endorsement or misrepresent origin. If you redistribute a modified version, you should remove QuantDinger branding and rebrand unless you have a commercial license.
-
-If you need to keep/modify QuantDinger branding in a redistribution (including UI branding and logo usage), please contact us for a **commercial license**.
-
-See: `TRADEMARKS.md`
-
-### What you get with a Commercial License
-
-- **Commercial authorization** to modify branding/copyright display as agreed
-- **Operations support**: deployment, upgrades, incident support, and maintenance guidance
-- **Consulting services**: architecture review, performance tuning, strategy workflow consulting
-- **Sponsorship options**: become a project sponsor and we can **display your logo/ad** (README/website/in-app placement as agreed)
-
-### Contact
-
-- **Telegram**: `https://t.me/worldinbroker`
-- **Email**: [brokermr810@gmail.com](mailto:brokermr810@gmail.com)
-
----
-
-
-### ๐ Direct Support (Donations)
-
-Your contributions help us maintain and improve QuantDinger.
+### ๐ Support the Project
**Crypto Donations (ERC-20 / BEP-20 / Polygon / Arbitrum)**
@@ -688,46 +515,36 @@ Your contributions help us maintain and improve QuantDinger.
### ๐ Supporting Partners
-We are proud to be supported by academic institutions and organizations advancing quantitative finance education and research.
-
- 
+
Quantitative Finance Society (QFS)
- Indiana University Bloomington
- Fostering the next generation of quantitative finance professionals
+ Indiana University Bloomington
|
-> ๐ก **Interested in becoming a supporting partner?** We welcome collaborations with universities, research institutions, and organizations. Contact us at [brokermr810@gmail.com](mailto:brokermr810@gmail.com) or via [Telegram](https://t.me/worldinbroker).
+> ๐ก **Want to become a partner?** Contact [brokermr810@gmail.com](mailto:brokermr810@gmail.com) or [Telegram](https://t.me/worldinbroker).
---
### Acknowledgements
-QuantDinger stands on the shoulders of great open-source projects:
+| Project | Link |
+|---------|------|
+| Flask | [flask.palletsprojects.com](https://flask.palletsprojects.com/) |
+| Pandas | [pandas.pydata.org](https://pandas.pydata.org/) |
+| CCXT | [github.com/ccxt/ccxt](https://github.com/ccxt/ccxt) |
+| yfinance | [github.com/ranaroussi/yfinance](https://github.com/ranaroussi/yfinance) |
+| Vue.js | [vuejs.org](https://vuejs.org/) |
+| Ant Design Vue | [antdv.com](https://antdv.com/) |
+| KlineCharts | [github.com/klinecharts/KLineChart](https://github.com/klinecharts/KLineChart) |
+| ECharts | [echarts.apache.org](https://echarts.apache.org/) |
-| Project | Description | Link |
-|---------|-------------|------|
-| **Flask** | Lightweight WSGI web framework | [flask.palletsprojects.com](https://flask.palletsprojects.com/) |
-| **flask-cors** | Cross-Origin Resource Sharing extension | [GitHub](https://github.com/corydolphin/flask-cors) |
-| **Pandas** | Data analysis and manipulation library | [pandas.pydata.org](https://pandas.pydata.org/) |
-| **CCXT** | Cryptocurrency exchange trading library | [github.com/ccxt/ccxt](https://github.com/ccxt/ccxt) |
-| **yfinance** | Yahoo Finance market data downloader | [github.com/ranaroussi/yfinance](https://github.com/ranaroussi/yfinance) |
-| **akshare** | China financial data interface | [github.com/akfamily/akshare](https://github.com/akfamily/akshare) |
-| **bip-utils** | HD wallet key derivation (BIP-32/44) | [GitHub](https://github.com/ebellocchia/bip_utils) |
-| **Vue.js** | Progressive JavaScript framework | [vuejs.org](https://vuejs.org/) |
-| **Ant Design Vue** | Enterprise-class UI components | [antdv.com](https://antdv.com/) |
-| **KlineCharts** | Lightweight financial charting library | [github.com/klinecharts/KLineChart](https://github.com/klinecharts/KLineChart) |
-| **Lightweight Charts** | TradingView charting library | [github.com/nicepkg/lightweight-charts](https://github.com/nicepkg/lightweight-charts) |
-| **ECharts** | Apache data visualization library | [echarts.apache.org](https://echarts.apache.org/) |
-| **Capacitor** | Cross-platform native runtime | [capacitorjs.com](https://capacitorjs.com/) |
-
-Thanks to all maintainers and contributors across these ecosystems! โค๏ธ
+Thanks to all maintainers and contributors! โค๏ธ