From 72bcc1f2846c8bf753aedb3ceac79e838150b65f Mon Sep 17 00:00:00 2001 From: Reynov Christian Date: Wed, 24 Dec 2025 13:01:42 +0800 Subject: [PATCH] Enhance documentation and guides for QuantumBotX - Updated DOCKER_GUIDE.md with additional clarity and formatting improvements. - Revised LICENSE.md for consistency in formatting. - Improved MT5_SETUP_GUIDE.md with clearer instructions and formatting. - Enhanced PACKAGING_README.md for better user guidance and clarity. - Updated QUICK_START_GUIDE.md for improved readability and formatting. - Revised README.md to enhance clarity and structure, including feature highlights. - Improved README_NEW.md for better onboarding experience and feature descriptions. - Enhanced README_STREAMLIT.md with clearer deployment instructions and feature highlights. - Updated ROADMAP.md to reflect upcoming features and project timelines. --- CHANGELOG.md | 55 +++++++++++++++++++++++++++++++---- DOCKER_GUIDE.md | 19 +++++++++++++ LICENSE.md | 2 +- MT5_SETUP_GUIDE.md | 32 +++++++++++++++++++-- PACKAGING_README.md | 38 ++++++++++++++++++++----- QUICK_START_GUIDE.md | 7 +++-- README.md | 68 +++++++++++++++++++++++++++++++++++++------- README_NEW.md | 22 ++++++++++++-- README_STREAMLIT.md | 42 +++++++++++++++++++-------- ROADMAP.md | 6 +++- 10 files changed, 246 insertions(+), 45 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b1c4a25..b4b5d73 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # ๐Ÿ“‹ QuantumBotX Changelog ## ๐Ÿ”„ **BETA Status: Open-Source Release" + **Version:** BETA v2.0.2 **Date:** September 2025 **Status:** ๐Ÿงช BETA (Ready for public testing) @@ -10,6 +11,7 @@ ## ๐ŸŽฏ **Investment Highlights** **Why QuantumBotX Stands Out:** + - **Educational Focus**: One of the few trading platforms with comprehensive beginner education - **Cultural Intelligence**: Specifically designed for Indonesian market psychology and Islamic calendar - **Risk-Conscious**: Ultra-conservative defaults and beginner safeguards @@ -20,6 +22,7 @@ ## ๐Ÿ“ˆ **v2.0.3 - "Global Expansion & Multilingual"** โœจ ### ๐ŸŒ **Internationalization (i18n) System** โญโญโญ + - **Complete Language Support**: Indonesian and English fully implemented - **Global Language Switcher**: Fixed position toggle in top-right corner - **Persistent Language Preferences**: Remembers user choice across sessions @@ -27,6 +30,7 @@ - **Centralized Translation**: 80+ UI elements translated with clean dictionary system ### ๐ŸŽฏ **Data Integration Enhancements** + - **Smart MT5 Detection**: Intelligent environment checking with fallback guidance - **Automatic Data Download**: One-click market data fetching with progress tracking - **Multi-Instrument Support**: Forex, Gold, Indices, Commodities, Crypto data handling @@ -34,6 +38,7 @@ - **Data Quality Verification**: Automatic validation of downloaded historical data ### ๐Ÿ›  **Setup & Installation Improvements** + - **Automated MT5 Installer**: One-command setup script with dependency management - **Comprehensive Setup Guide**: 50+ page MT5 integration documentation - **Environment Configuration**: Enhanced .env templates with broker-specific settings @@ -41,6 +46,7 @@ - **Troubleshooting Guides**: Detailed error resolution for common setup issues ### โš™๏ธ **Settings & Preferences Expansion** + - **Global App Settings**: Language, theme, and user preferences management - **Profile Management**: User profile editing with local data storage - **Quick Settings Panel**: Toggle notifications, auto-updates, demo mode @@ -48,12 +54,14 @@ - **Future API Preview**: Preparatory UI for upcoming QuantumBotX API features ### ๐Ÿ“Š **Navigation & UI Improvements** + - **Dynamic Navigation**: Context-aware menu items based on language and features - **Real-time Updates**: Language changes apply instantly without page reload - **Holiday Integration**: Bahasa Indonesia support for Ramadan/Christmas features - **Accessibility Enhancement**: Better screen reader support with proper labels ### ๐Ÿ”ง **Developer Experience** + - **Global Translation System**: Page-agnostic translation keys for consistent UI - **Dynamic Content Loading**: SEO-friendly progressive enhancement - **Fallback Translation**: Intelligent English fallback for missing translations @@ -64,18 +72,21 @@ ## ๐Ÿ“ˆ **v2.0.2 - "Production Ready Improvements"** ### ๐Ÿ”ฅ **Critical Bug Fixes** + - **Symbol Validation**: Fixed automated broker symbol detection and migration - **Backtest Stability**: Enhanced data validation and error recovery in backtesting engine - **Memory Optimization**: Reduced RAM usage for long-running bots with data cleanup - **Database Integrity**: Strengthened SQLite connection pooling and retry mechanisms ### โšก **Performance Enhancements** + - **Bot Initialization**: 40% faster bot startup with optimized symbol verification - **Backtest Speed**: Parallel processing for multiple backtest scenarios - **API Response Time**: Optimized Flask routes for faster dashboard loading - **Data Download**: Intelligent caching system for historical market data ### ๐Ÿ›ก๏ธ **Safety Improvements** + - **Account Protection**: Enhanced emergency brakes with multiple kill switches - **Risk Validation**: Double-validation of lot sizes and risk percentages - **Holiday Detection**: Improved Ramadan/Christmas trading pause mechanisms @@ -84,11 +95,13 @@ --- ## ๐ŸŽช **v2.0 - "Professional Foundation"** (Completed) -*Released: September 2025* + +Released: September 2025 ### ๐Ÿš€ **Major New Features** #### ๐Ÿง  **AI-Powered Indonesian Mentor** โญโญโญ + - **Personal Guidance**: Indonesian-language AI mentor with cultural understanding - **Emotional Analysis**: Evaluates trading psychology and provides coping strategies - **Risk Assessment**: Intelligent evaluation of risk/reward patterns @@ -96,18 +109,21 @@ - **Database Integration**: Automatic trade logging for AI analysis #### ๐ŸŽฏ **Strategy Switcher System** โญโญโญ + - **Market Condition Detection**: Automatic trending/ranging/volatile market identification - **Dynamic Strategy Adaptation**: Switches strategies based on current market regime - **Performance Scoring**: Algorithm ranks strategy effectiveness - **Seamless Transitions**: 0-downtime strategy switching #### ๐Ÿ“Š **Advanced Backtesting Engine** โญโญโญ + - **Realistic Cost Modeling**: Includes spreads, slippage, and execution costs - **Instrument-Specific Logic**: Different parameters for Forex, Gold, Crypto, Indices - **Performance Analytics**: Detailed equity curves, drawdowns, Sharpe ratio - **Multi-Timeframe Analysis**: Cross-validation across different timeframes #### ๐ŸŒ **Index Trading Expansion** โญโญโญ + - **Stock Index Support**: Professional US30, US100, US500, DE30 trading - **Index Momentum Strategy**: Gap detection and institutional-level analysis - **Conservative Position Sizing**: Risk-adjusted money management for indices @@ -116,12 +132,14 @@ ### ๐Ÿ“ˆ **Enhanced Trading Strategies** #### ๐ŸŒŸ **New Strategies Added** + - **Index Momentum**: Stock index momentum with institutional-grade analysis - **Index Breakout Pro**: Professional breakout detection for indices - **Market Condition Detector**: Smart market regime switching - **Performance Scorer**: Strategy evaluation and ranking system #### ๐Ÿ›  **Strategy Improvements** + - **ATR Improvements**: More sophisticated volatility measurements - **Multi-Timeframe**: Enhanced analysis across timeframes - **Risk Controls**: Better integration with emergency breaks @@ -130,12 +148,14 @@ ### ๐ŸŽ“ **Educational Framework Expansion** #### ๐Ÿ“š **Documentation Suite** + - **Beginner Guide**: Step-by-step learning path (Week 1-12) - **FAQ System**: Comprehensive answers to common questions - **Quick Start**: Fast-track setup for experienced traders - **Parameter Education**: Plain English explanations for all settings #### ๐Ÿงญ **Learning Improvements** + - **Strategy Ratings**: 2-12 complexity scale with market guidance - **Market-Specific**: Tailored recommendations by asset class - **Progressive Learning**: Week-by-week improvement plans @@ -144,12 +164,14 @@ ### ๐Ÿ›ก๏ธ **Safety & Risk Management** #### โšก **Safety Features** + - **Emergency Brakes**: Multiple layers of account protection - **Volatility Protection**: Automatic position reduction in turbulence - **Beginner Safeguards**: Parameter capping and warning systems - **Conservative Defaults**: Safe starting configurations #### ๐Ÿ“Š **Risk Management** + - **ATR-Based Sizing**: Dynamic position sizing based on volatility - **Account Protection**: Percentage-of-account risk limits - **Position Validation**: Real-time position size verification @@ -158,12 +180,14 @@ ### ๐ŸŒ **Multi-Broker & Multi-Asset** #### ๐Ÿ› **Broker Support** + - **XM Indonesia**: Specialized Indonesian market support - **Exness**: Verified integration with ultra-low spreads - **Alpari, FBS**: Additional broker compatibility - **Symbol Migration**: Automatic broker symbol mapping #### ๐Ÿ’ฐ **Asset Classes** + - **Forex**: 10+ currency pairs with optimized strategies - **Gold (XAUUSD)**: Ultra-conservative handling with special protections - **Crypto**: 24/7 weekend mode for BTCUSD, ETHUSD @@ -173,12 +197,14 @@ ### ๐ŸŽ‰ **Cultural & Regional Features** #### ๐Ÿ‡ฎ๐Ÿ‡ฉ **Indonesian Market Focus** + - **Ramadan Mode**: Automatic prayer time detection and trading pauses - **Holiday Recognition**: Christmas and major Islamic holidays - **Time Zone Optimization**: Jakarta time (WIB) awareness - **Cultural Sensitivity**: Indonesian user interface and support #### ๐Ÿ•Œ **Islamic Features** + - **Zakat Calculator**: Post-profit Islamic giving calculations - **Charity Tracker**: Integration with Islamic charity platforms - **Ramadan Adjustments**: Modified risk parameters during holy month @@ -186,12 +212,14 @@ ### ๐Ÿงช **Development & Testing Infra** #### ๐Ÿงช **Testing Suite** + - **30+ Test Scripts**: Comprehensive validation framework - **Multi-Broker Testing**: Cross-broker compatibility verification - **Strategy Testing**: Individual strategy performance validation - **Integration Testing**: End-to-end workflow verification #### ๐Ÿ”ง **Development Tools** + - **Symbol Migration Tools**: Automated broker symbol discovery - **Bot State Management**: Debug and recovery utilities - **Performance Analysis**: Bottleneck identification and optimization @@ -200,12 +228,14 @@ ### ๐Ÿ–ฅ **User Experience** #### ๐Ÿ“ฑ **Interface Improvements** + - **Dashboard Design**: Cleaner, more intuitive interface - **Real-Time Updates**: Live bot status and performance - **Error Handling**: User-friendly error messages in Indonesian - **Export Features**: CSV export for trading records #### โš™ **Configuration** + - **Easy Setup**: Simplified configuration process - **Parameter Guidance**: Contextual help for settings - **Save/Load Profiles**: Configurable trading profiles @@ -214,9 +244,11 @@ --- ## ๐Ÿ“Š **v1.0 - "Core Trading Platform"** -*Released: Early 2025* + +Released: Early 2025 ### ๐ŸŽฏ **Core Features Delivered** + - Basic MT5 integration and bot management - 6 initial trading strategies (MA Crossover, RSI, Bollinger) - Simple backtesting capabilities @@ -228,9 +260,11 @@ --- ## ๐ŸŒŸ **v0.5 - "Prototype & Testing"** -*Released: Mid-2024* + +Released: Mid-2024 ### ๐Ÿงช **Prototype Features** + - Initial MT5 API integration - Basic bot framework - Simple strategy architecture @@ -242,6 +276,7 @@ ## ๐Ÿ”ฎ **Upcoming: v2.1 - "Intelligence Enhancement"** ### ๐Ÿš€ **Planned Features** + - **Telegram Notifications**: Real-time trading alerts and performance updates - **MACD_STOCH_FILTER**: Advanced precision entry strategy - **Smart Parameter Optimization**: AI-assisted strategy tuning @@ -253,12 +288,14 @@ ## ๐Ÿ“Š **Performance Metrics (v2.0)** ### ๐Ÿ† **Backtest Results (Across All Strategies)** + - **Historical Testing**: 5+ years of market data tested - **Average Win Rate**: 58-72% across different market conditions - **Maximum Drawdown**: Controlled below 15% in backtests - **Annualized Returns**: 15-35% depending on risk tolerance ### ๐Ÿงช **Real-world Testing** + - **Demo Account Testing**: 6+ months of live demo trading - **Strategy Validation**: Cross-market performance verification - **Risk Assessment**: Conservative parameter validation @@ -269,12 +306,14 @@ ## ๐Ÿ”’ **Security & Compliance** ### ๐Ÿ›ก๏ธ **Security Measures** + - **Account Protection**: Conservative risk limits and emergency brakes - **Input Validation**: All user inputs validated and sanitized - **Error Handling**: Comprehensive error catching and logging - **API Security**: Secure credential management and storage ### ๐Ÿ“ **Compliance Features** + - **Risk Warnings**: Multiple layers of trading risk disclosures - **Conservative Defaults**: Safe starting configurations - **Educational Emphasis**: Strong focus on learning and risk awareness @@ -287,18 +326,21 @@ **Welcome to Our BETA Program!** ๐ŸŽ‰ ### ๐ŸŽฏ **What We're Testing** + - **Stability**: Platform reliability under various market conditions - **Performance**: Strategy effectiveness across different brokers - **User Experience**: Interface usability and learning curve - **Educational Value**: How effectively users learn to trade safely ### ๐Ÿ“‹ **Beta Participation Requirements** + - Active trading account (demo account available) - Computer with MetaTrader 5 installed - Internet connection for real-time trading - Willingness to provide feedback and bug reports ### ๐ŸŽ **Beta Benefits** + - **Full Feature Access**: Complete v2.0 feature set - **Direct Developer Access**: Rapid bug fixes and feature requests - **Exclusive Community**: Premium trading group access @@ -309,12 +351,14 @@ ## ๐Ÿค **Contributing & Community** ### ๐Ÿ›  **Open-Source Contribution** + - **Feature Requests**: GitHub issues for enhancement suggestions - **Bug Reports**: Detailed bug reports with reproduction steps - **Code Contributions**: Pull requests welcome for improvements - **Documentation**: Help improve guides and tutorials ### ๐ŸŒ **Community Support** + - **Indonesian Support**: Native language assistance - **Educational Resources**: Community learning materials - **Market Insights**: Indonesian trading community integration @@ -324,9 +368,10 @@ ## ๐Ÿ“ˆ **Vision: v3.0 - "AI Revolution"** -*Aimed for: 2025-2026* +Aimed for: 2025-2026 ### ๐Ÿš€ **Planned AI Features** + - **Machine Learning Optimization**: Predictive strategy performance - **Sentiment Analysis**: News and social media integration - **Multi-Broker Arbitrage**: Automatic cross-broker opportunities @@ -350,4 +395,4 @@ --- -*Last updated: September 2025 | ยฉ Chrisnov IT Solutions* +Last updated: September 2025 | ยฉ Chrisnov IT Solutions diff --git a/DOCKER_GUIDE.md b/DOCKER_GUIDE.md index 67832da..b2f9010 100644 --- a/DOCKER_GUIDE.md +++ b/DOCKER_GUIDE.md @@ -20,6 +20,7 @@ ```bash docker-compose up -d ``` + - This will build the image (first time only) and start the container - `-d` runs it in detached mode (background) @@ -28,6 +29,7 @@ ```bash docker ps ``` + You should see `quantumbotx-quantumbotx-1` in the list 5. **Access your application** @@ -126,10 +128,12 @@ docker system prune -a --volumes ### Environment Variables Your app reads configuration from: + 1. `.env` file (for local development) 2. `docker-compose.yml` (environment section for Docker) **Important environment variables:** + - `BROKER_TYPE`: Set to `CCXT` for crypto trading (default in Docker) - `EXCHANGE_ID`: Exchange to use (e.g., `binance`, `bybit`) - `FLASK_HOST`: Host to bind to (default: `0.0.0.0` in Docker) @@ -138,6 +142,7 @@ Your app reads configuration from: ### Volumes (Data Persistence) Your `docker-compose.yml` mounts these directories: + - `./data:/app/data` - Database and persistent data - `./logs:/app/logs` - Application logs @@ -151,23 +156,29 @@ Your `docker-compose.yml` mounts these directories: 1. **Make code changes** on your Windows machine 2. **Rebuild the container**: + ```bash docker-compose up --build -d ``` + 3. **Check logs** to see if it worked: + ```bash docker logs -f quantumbotx-quantumbotx-1 ``` + 4. **Test your changes** at `http://localhost:5000` ### Debugging Workflow 1. **Check if container is running**: + ```bash docker ps ``` 2. **If it's restarting**, check the logs: + ```bash docker logs quantumbotx-quantumbotx-1 ``` @@ -178,6 +189,7 @@ Your `docker-compose.yml` mounts these directories: - Or enter the container to debug: `docker exec -it quantumbotx-quantumbotx-1 /bin/bash` 4. **Test inside the container**: + ```bash docker exec -it quantumbotx-quantumbotx-1 /bin/bash # Now you're inside the container @@ -194,9 +206,11 @@ When you're ready to deploy to a server: 1. **Copy your project** to the server 2. **Make sure `.env` is configured** with production credentials 3. **Start with**: + ```bash docker-compose up -d ``` + 4. **Set up auto-restart** (already configured with `restart: unless-stopped`) --- @@ -233,6 +247,7 @@ docker stats --no-stream ### Issue: Container keeps restarting **Solution:** + ```bash # Check the logs for errors docker logs quantumbotx-quantumbotx-1 @@ -246,6 +261,7 @@ docker logs quantumbotx-quantumbotx-1 ### Issue: Can't access localhost:5000 **Solution:** + ```bash # Check if container is running docker ps @@ -260,6 +276,7 @@ docker exec quantumbotx-quantumbotx-1 curl http://localhost:5000/api/health ### Issue: Changes not reflecting **Solution:** + ```bash # You need to rebuild after code changes docker-compose up --build -d @@ -272,6 +289,7 @@ docker-compose up -d ### Issue: Out of disk space **Solution:** + ```bash # Clean up old images and containers docker system prune @@ -304,6 +322,7 @@ docker system prune -a --volumes ## ๐Ÿ†˜ Need Help? If you're stuck: + 1. Check the logs: `docker logs quantumbotx-quantumbotx-1` 2. Verify the container is running: `docker ps` 3. Try rebuilding: `docker-compose up --build -d` diff --git a/LICENSE.md b/LICENSE.md index 1240ee6..17be876 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -MIT License +# MIT License Copyright (c) 2025 Reynov Christian diff --git a/MT5_SETUP_GUIDE.md b/MT5_SETUP_GUIDE.md index c77b434..d800bb9 100644 --- a/MT5_SETUP_GUIDE.md +++ b/MT5_SETUP_GUIDE.md @@ -1,4 +1,3 @@ -/** eslint-disable markdown/fenced-code-language */ # ๐Ÿš€ QuantumBotX MT5 Integration Guide > **Get Historical Market Data for Advanced Backtesting** @@ -6,6 +5,7 @@ ## ๐Ÿ“‹ Prerequisites **Required Software:** + - โœ… [MetaTrader 5 Platform](https://www.metatrader5.com/en/download) (Latest version) - โœ… Python 3.8+ (Already included with QuantumBotX) - โœ… Active MT5 Demo or Live Account @@ -15,6 +15,7 @@ ## โšก Quick Setup (3 Steps) ### Step 1: Install MT5 Platform + ```text 1. Download MT5 from: https://www.metatrader5.com/en/download 2. Install in default location: C:\Program Files\MetaTrader 5 @@ -23,6 +24,7 @@ ``` ### Step 2: Configure QuantumBotX Settings + ```bash # Copy and edit your .env file cp .env.example .env @@ -34,7 +36,9 @@ MT5_SERVER=FBS-Demo # Your broker server ``` ### Step 3: Install MT5 Python Library + **Windows Command:** + ```bash # Open Command Prompt as Administrator pip install MetaTrader5 @@ -50,6 +54,7 @@ pip install -r requirements.txt If standard installation fails: ### Method A: Wheel File (Recommended) + ```bash # Download the wheel file manually pip install MetaTrader5-5.0.45-cp38-cp38-win_amd64.whl @@ -58,6 +63,7 @@ pip install MetaTrader5-5.0.45-cp38-cp38-win_amd64.whl ``` ### Method B: Conda Environment + ```bash # Create dedicated environment conda create -n qb_mt5 python=3.9 @@ -72,12 +78,14 @@ conda install MetaTrader5 -c conda-forge ## ๐ŸŒ Supported Brokers **Pre-configured for:** + - โœ… FBS Markets (FBS-Demo) - โœ… XM Global (XMGlobal-Real/live server names) - โœ… IC Markets (ICMarkets-Demo) - โœ… Pepperstone (Pepperstone-Demo) **For other brokers:** + ```env # Add to your .env file: MT5_SERVER=YourBroker-ServerName @@ -88,6 +96,7 @@ MT5_SERVER=YourBroker-ServerName ## ๐Ÿ—‚๏ธ Data Download Features ### Automatic Symbol Detection + - **Forex:** EURUSD, GBPUSD, AUDUSD, JPY pairs, etc. - **Gold:** XAUUSD (ultra-conservative risk management) - **Indices:** US30, US100, US500 (S&P 500, Dow Jones) @@ -96,6 +105,7 @@ MT5_SERVER=YourBroker-ServerName - **Exotic Pairs:** Currency pairs not in default list ### What Gets Downloaded + - โœ… OHLCV data (Open, High, Low, Close, Volume) - โœ… Multiple timeframes (H1 recommended for backtesting) - โœ… Last 4+ years of historical data @@ -108,11 +118,14 @@ MT5_SERVER=YourBroker-ServerName ## ๐Ÿšฆ Testing Your Setup ### Test 1: MT5 Connection + ```bash # Run the download script directly python lab/download_data.py ``` + **Expected Output:** + ```text โœ… Successfully connected to MT5 ๐Ÿ“ก Server: FBS-Demo @@ -125,6 +138,7 @@ python lab/download_data.py ``` ### Test 2: Web Interface + ```text 1. Start QuantumBotX: python run.py 2. Open: http://localhost:5000/backtest @@ -137,6 +151,7 @@ python lab/download_data.py ## ๐Ÿ› Troubleshooting ### Error: "MetaTrader5 module not found" + ```bash # Windows installation fix pip uninstall MetaTrader5 @@ -147,6 +162,7 @@ pip install MetaTrader5-5.0.34-cp39-cp39-win_amd64.whl ``` ### Error: "Failed to initialize MT5" + ```text โœ… Check MT5 is running โœ… Verify account credentials in .env @@ -155,6 +171,7 @@ pip install MetaTrader5-5.0.34-cp39-cp39-win_amd64.whl ``` ### Error: "Symbol not found" + ```text โœ… MT5 shows: "Enable Auto Trading" in algo settings โœ… Check if symbol is visible in MT5 Market Watch @@ -163,6 +180,7 @@ pip install MetaTrader5-5.0.34-cp39-cp39-win_amd64.whl ``` ### Error: "Download timed out" + ```text โœ… Reduce download period in script if needed โœ… Check internet connection stability @@ -175,12 +193,15 @@ pip install MetaTrader5-5.0.34-cp39-cp39-win_amd64.whl ## ๐Ÿ”„ Advanced Configuration ### Custom Symbol List + Add to your `.env` file: + ```env CUSTOM_MT5_SYMBOLS=GBPAUD,NZDCAD,USDMXN,HK50,AUS200 ``` ### Proxy Settings (if needed) + ```env MT5_PROXY_HOST=your.proxy.host MT5_PROXY_PORT=8080 @@ -189,6 +210,7 @@ MT5_PROXY_PASS=password ``` ### Log Level Control + ```env BACKTEST_LOG_LEVEL=DEBUG # For troubleshooting ``` @@ -198,6 +220,7 @@ BACKTEST_LOG_LEVEL=DEBUG # For troubleshooting ## ๐Ÿ“Š Data Quality Verification After download, check your CSV files: + ```python import pandas as pd df = pd.read_csv('lab/backtest_data/EURUSD_H1_data.csv') @@ -207,6 +230,7 @@ print(f"Latest close: {df['close'].iloc[-1]}") ``` **Expected Output:** + ```text Rows: 15800+ (4+ years of H1 data) Date range: 2020-01-01 to current_date @@ -227,16 +251,18 @@ Latest close: matches MT5 current price ## ๐Ÿ“ž Support **Common Issues:** + - MT5 needs to remain logged in during downloads - Some brokers require manual symbol activation - Demo accounts sometimes have download limits - VPN may be needed for some broker connections **Help Resources:** -- MT5 Official Documentation: https://www.metatrader5.com + +- MT5 Official Documentation: - QuantumBotX Issue Tracker: Check GitHub issues - Community: Join Discord/Telegram for support --- -*Happy Trading! ๐ŸŽฏ๐Ÿ“ˆ* +Happy Trading! ๐ŸŽฏ๐Ÿ“ˆ diff --git a/PACKAGING_README.md b/PACKAGING_README.md index 32e3fc8..f7228c3 100644 --- a/PACKAGING_README.md +++ b/PACKAGING_README.md @@ -15,13 +15,15 @@ This guide explains how to package your QuantumBotX trading application into a W ## ๐Ÿ“‹ Prerequisites ### For Building the Package + 1. **Python 3.8+** (already installed) 2. **PyInstaller** (already installed via this guide) 3. **NSIS (Optional)** - For creating the installer EXE - - Download from: https://nsis.sourceforge.io/Download + - Download from: - Install and ensure `makensis` is in your PATH ### For End Users + 1. **Windows 7+** (64-bit recommended) 2. **MetaTrader 5** - Must be installed separately 3. **Internet Connection** - For initial setup @@ -29,11 +31,13 @@ This guide explains how to package your QuantumBotX trading application into a W ## ๐Ÿš€ Quick Start ### Option 1: Build Everything (Recommended) + ```bash python build_installer.py ``` ### Option 2: Manual Build Process + ```bash # 1. Build with PyInstaller pyinstaller --clean quantumbotx.spec @@ -58,15 +62,17 @@ dist/QuantumBotX/ # PyInstaller output (for troubleshooting) ## ๐ŸŽฎ For End Users ### Installation Process + 1. **Download** `QuantumBotX-Installer.exe` 2. **Run** the installer (requires admin privileges) 3. **Follow** the setup wizard 4. **Launch** from desktop shortcut or start menu ### Daily Usage + 1. **Start MetaTrader 5** first 2. **Launch QuantumBotX** via desktop shortcut or start menu -3. **Open browser** to http://127.0.0.1:5000 +3. **Open browser** to 4. **Configure settings** if needed ## ๐Ÿ”ง Configuration Files @@ -83,16 +89,19 @@ The installer includes these configuration files: ### Build Issues **PyInstaller fails:** + ```bash # Clean and rebuild pyinstaller --clean quantumbotx.spec ``` **NSIS not found:** -- Install NSIS from https://nsis.sourceforge.io/ + +- Install NSIS from - Or use the portable version instead **Missing dependencies:** + ```bash pip install -r requirements.txt ``` @@ -100,15 +109,18 @@ pip install -r requirements.txt ### Runtime Issues **Application won't start:** + - Check if MetaTrader 5 is running - Verify `.env` file has correct credentials - Check Windows Event Viewer for errors **Port already in use:** + - Close other applications using port 5000 - Or modify `FLASK_PORT` in `.env` file **MetaTrader 5 connection fails:** + - Verify MT5 credentials in `.env` - Ensure MT5 is running and logged in - Check MT5 terminal for connection status @@ -116,10 +128,12 @@ pip install -r requirements.txt ## ๐Ÿ“ฆ Distribution ### For Technical Users + - Share `QuantumBotX-Installer.exe` for full installation - Or share `QuantumBotX-Portable.zip` for manual installation ### For Non-Technical Users + 1. **Share the installer** `QuantumBotX-Installer.exe` 2. **Provide simple instructions:** - Double-click to install @@ -128,6 +142,7 @@ pip install -r requirements.txt - Ensure MetaTrader 5 is running ### System Requirements for End Users + - **OS:** Windows 7 SP1+ (64-bit recommended) - **RAM:** 4GB minimum, 8GB recommended - **Storage:** 500MB free space @@ -137,12 +152,14 @@ pip install -r requirements.txt ## ๐Ÿ”„ Updates and Maintenance ### Creating Updates + 1. **Increment version** in `installer.nsi` 2. **Rebuild** using `python build_installer.py` 3. **Test** on clean system 4. **Distribute** new installer ### Uninstallation + - Use Windows Add/Remove Programs - Or run `Uninstall.exe` from installation directory - Or use the uninstall shortcut in Start Menu @@ -151,32 +168,39 @@ pip install -r requirements.txt ### Common User Questions -**"How do I configure my MT5 credentials?"** +#### "How do I configure my MT5 credentials?" + - Copy `.env.example` to `.env` - Edit `.env` with your MT5 account details - Restart the application -**"The application says MT5 is not connected"** +#### "The application says MT5 is not connected" + - Ensure MetaTrader 5 is running - Check MT5 login credentials - Verify MT5 server settings -**"I can't access the web interface"** +#### "I can't access the web interface" + - Check if the application is running -- Verify the URL: http://127.0.0.1:5000 +- Verify the URL: - Check firewall settings ## ๐ŸŽฏ Advanced Configuration ### Customizing the Installer + Edit `installer.nsi` to: + - Change installation directory - Modify shortcuts - Add custom messages - Include additional files ### Customizing PyInstaller + Edit `quantumbotx.spec` to: + - Add/remove files - Change executable properties - Modify hidden imports diff --git a/QUICK_START_GUIDE.md b/QUICK_START_GUIDE.md index a448c68..d494e94 100644 --- a/QUICK_START_GUIDE.md +++ b/QUICK_START_GUIDE.md @@ -3,7 +3,7 @@ ## First Time Setup 1. **Install MetaTrader 5** (Required) - - Download from: https://www.metatrader5.com/ + - Download from: - Install and create a demo account - Keep MT5 running in the background - โš ๏ธ **IMPORTANT:** MetaTrader 5 must be running for QuantumBotX to work @@ -11,6 +11,7 @@ 2. **Configure Your Settings** - Copy `.env.example` to `.env` - Edit `.env` with your MT5 credentials: + ```ini MT5_LOGIN=your_account_number MT5_PASSWORD=your_password @@ -19,7 +20,7 @@ 3. **Start the Application** - Double-click `start.bat` (Windows) - - Open http://127.0.0.1:5000 in your browser + - Open in your browser ## โœ… System Requirements @@ -34,7 +35,7 @@ 1. Start MetaTrader 5 first 2. Run `start.bat` -3. Open your web browser to http://127.0.0.1:5000 +3. Open your web browser to ## Troubleshooting diff --git a/README.md b/README.md index 41cfbc5..965b40c 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,11 @@ Designed to be elegant, powerful, and flexible โ€” whether you're a scalper, swi ## โš ๏ธ Platform Support Notice ### **Primary Platform: Windows** ๐ŸชŸ + This version of QuantumBotX is **optimized for Windows** and requires MetaTrader 5 terminal to be installed locally. It's designed for learning algorithmic trading on your personal computer. ### **Alternative Platforms** ๐Ÿ”„ + - **Linux**: Can attempt using Wine (experimental - see Linux Setup guide below) - **macOS**: Not officially supported (requires Wine or Windows VM) - **Cloud/VPS**: Not compatible (requires local MT5 terminal) @@ -27,6 +29,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader ## ๐Ÿš€ Features ### ๐ŸŽฏ **Core Trading Engine** + - โœ… **Modular Strategy System**: 16+ professional trading strategies with plug-and-play architecture - โœ… **ATR-Based Risk Management**: Dynamic position sizing that adapts to market volatility with realistic backtesting - โœ… **Advanced Backtesting Engine**: Realistic spread/slippage modeling with instrument-specific configurations @@ -37,6 +40,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader - โœ… **Market Condition Detector**: Real-time market regime analysis (trending/ranging/volatile) ### ๐Ÿง  **AI-Powered Mentorship** + - โœ… **Indonesian AI Mentor**: Personal trading mentor dengan bahasa Indonesia, analisis emosi vs performa - โœ… **Cultural Intelligence**: Supportif seperti mentor manusia dengan konteks budaya Indonesia - โœ… **Personalized Guidance**: Analisis pola trading, evaluasi risiko, dan rekomendasi strategi @@ -44,6 +48,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader - โœ… **Database Integration**: Log semua trade untuk analisis AI dan feedback yang lebih baik ### ๐ŸŽ“ **Educational Framework** + - โœ… **Beginner-Friendly System**: Progressive learning path from Week 1 to Month 3 - โœ… **Strategy Difficulty Ratings**: 2-12 complexity scale with automatic recommendations - โœ… **Parameter Education**: Every setting explained in plain English @@ -52,6 +57,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader - โœ… **Database Migration System**: Seamless version upgrades with `migrate_db.py` ### ๐Ÿ“Š **Advanced Analytics** + - โœ… **Comprehensive Backtester**: Historical testing with interactive Chart.js visualizations - โœ… **Performance Tracking**: Detailed trade logs, equity curves, and profit analysis - โœ… **Real-Time Dashboard**: Live data visualization and bot monitoring @@ -59,6 +65,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader - โœ… **Risk Analytics**: Drawdown analysis and portfolio performance metrics ### ๐ŸŒ **Multi-Asset Trading** + - โœ… **Forex Optimization**: EURUSD, GBPUSD, USDJPY with trend-following strategies - โœ… **Gold Trading Protection**: Ultra-conservative XAUUSD position sizing with ATR limits - โœ… **Crypto Excellence**: Bitcoin/Ethereum bots with 24/7 weekend trading mode @@ -66,6 +73,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader - โœ… **Cross-Platform Foundation**: cTrader, Interactive Brokers architecture ### ๐ŸŽ‰ **Culturally-Aware Features** + - โœ… **Automatic Holiday Detection**: Christmas and Ramadan modes activate automatically - โœ… **Ramadan Trading Mode**: Respects prayer times with automatic trading pauses - โœ… **Cultural Sensitivity**: UI themes and greetings for both Christian and Muslim traders @@ -73,6 +81,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader - โœ… **Seasonal Adjustments**: Risk management adapts to holiday market conditions ### ๐Ÿ›ก๏ธ **Professional Safety** + - โœ… **Automated Risk Control**: 1% max risk per trade with emergency brake system - โœ… **Volatility Protection**: ATR-based position scaling during market turbulence - โœ… **Beginner Safeguards**: Parameter validation prevents dangerous settings @@ -84,6 +93,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader ## ๐Ÿš€ Development & Testing Framework ### ๐Ÿงช **Testing Infrastructure** + - โœ… **30+ Test Scripts**: Comprehensive testing suite in dedicated `testing/` directory - โœ… **Multi-Broker Testing**: XM Global, Exness, Alpari compatibility validation - โœ… **Strategy Validation**: Individual strategy testing and parameter optimization @@ -93,6 +103,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader - โœ… **Risk Management Tests**: XAUUSD protection and ATR-based sizing validation ### ๐Ÿ”ง **Development Tools** + - โœ… **Symbol Migration Tools**: Automatic broker symbol discovery and mapping - โœ… **Bot State Management**: Debug and fix tools for bot recovery - โœ… **Performance Analysis**: Backtesting debugging and optimization tools @@ -117,40 +128,46 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader ## ๐Ÿง  Strategy Collection ### ๐ŸŽ“ **Beginner Strategies (Complexity 2-3/10)** + | Strategy | Description | Best For | Learning Focus | -|---|---|---|---| +| --- | --- | --- | --- | | `MA Crossover` | Classic Golden/Death Cross with beginner-safe defaults | EURUSD, trending markets | Understanding trend following | | `RSI Crossover` | Momentum analysis with RSI and moving average confirmation | FOREX pairs, momentum learning | Momentum concepts and timing | | `Turtle Breakout` | Price breakout above/below recent highs/lows | Gold, trending markets | Support/resistance levels | ### ๐Ÿ“š **Intermediate Strategies (Complexity 4-7/10)** + | Strategy | Description | Best For | Advanced Features | -|---|---|---|---| +| --- | --- | --- | --- | | `Bollinger Reversion` | Mean reversion when price touches Bollinger Bands | Ranging FOREX markets | Market cycle understanding | | `Ichimoku Cloud` | Japanese technical analysis with cloud confirmation | FOREX, comprehensive analysis | Multi-indicator synthesis | | `Pulse Sync` | Multi-timeframe MACD + Stochastic confirmation | FOREX, Gold | Multiple timeframe analysis | | `Bollinger Squeeze` | Volatility compression breakout detection | Gold, volatile markets | Volatility analysis | ### ๐ŸŽ† **Advanced Strategies (Complexity 5-8/10)** + | Strategy | Description | Best For | Professional Features | -|---|---|---|---| +| -------- | ----------- | -------- | --------------------- | | `Quantum Velocity` | EMA 200 + Bollinger Squeeze breakout system | Gold, crypto | Advanced volatility filtering | | `Mercy Edge` | AI-enhanced multi-timeframe with trend validation | FOREX, Gold | Professional-grade confirmation | | `QuantumBotX Hybrid` | ADX-adaptive strategy switching (trending vs ranging) | All markets | Market regime detection | | `Dynamic Breakout` | Adaptive breakout detection with volatility scaling | Gold, crypto | Dynamic parameter adjustment | ### ๐Ÿš€ **Expert Strategies (Complexity 10-12/10)** + | Strategy | Description | Best For | Specialized Features | -|---|---|---|---| +| -------- | ----------- | -------- | -------------------- | | `QuantumBotX Crypto` | Bitcoin/Ethereum optimized with 24/7 weekend mode | BTCUSD, ETHUSD | Crypto volatility management | ### ๐Ÿ“Š **Index Strategies (NEW!)** + - โœ… **Index Momentum**: Stock index momentum with gap detection for US500, US30 - โœ… **Index Breakout Pro**: Professional index breakout with institutional analysis - โœ… **Multi-Timeframe Analysis**: Daily, weekly, and monthly perspective for indices - โœ… **Risk-Adjusted Position Sizing**: Conservative approach for volatile index markets ### ๐ŸŽฏ **Market-Specific Optimization** + - **FOREX Trading**: MA Crossover, Ichimoku Cloud, Bollinger Reversion - **Gold (XAUUSD)**: Quantum Velocity, Turtle Breakout, Dynamic Breakout - **Cryptocurrency**: QuantumBotX Crypto, RSI Crossover with crypto detection @@ -162,6 +179,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader ## ๐Ÿ“ˆ Roadmap ### โœ… **v2.0 - Professional Foundation (COMPLETED)** + - โœ… **ATR-Based Risk Management**: Revolutionary position sizing system - โœ… **Multi-Broker Symbol Migration**: Automatic XM/Exness/Alpari compatibility - โœ… **Educational Framework**: Progressive learning system for beginners @@ -174,6 +192,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader - โœ… **Culturally-Aware Trading**: Automatic holiday detection for Christmas and Ramadan ### ๐Ÿšง **v2.1 - Intelligence Enhancement (IN DEVELOPMENT)** + - [ ] **Advanced Strategy**: `MACD_STOCH_FILTER` for more precise, filtered entries - [ ] **Telegram Notifications**: Real-time alerts for trades, errors, and performance - [ ] **Portfolio Analytics**: Advanced performance metrics and drawdown analysis @@ -182,6 +201,7 @@ This version of QuantumBotX is **optimized for Windows** and requires MetaTrader - [ ] **Risk Analytics Dashboard**: Real-time risk exposure and correlation analysis ### ๐Ÿš€ **v3.0 - AI Revolution (FUTURE VISION)** + - [ ] **Machine Learning Integration**: AI-powered strategy optimization - [ ] **Sentiment Analysis**: News and social media sentiment trading signals - [ ] **Multi-Broker Arbitrage**: Cross-broker price difference exploitation @@ -209,12 +229,15 @@ DB_NAME=bots.db ## ๐Ÿงช Local Setup (Dev Mode) -1. **Clone the repository:** +1. **Clone the repository:** + ```bash git clone https://github.com/rebarakaz/quantumbotx.git cd quantumbotx ``` -2. **Set up Python virtual environment:** + +2. **Set up Python virtual environment:** + ```bash python -m venv venv # On Windows @@ -222,20 +245,28 @@ DB_NAME=bots.db # On macOS/Linux source venv/bin/activate ``` -3. **Install dependencies:** + +3. **Install dependencies:** + ```bash pip install -r requirements.txt ``` -4. **Configure your environment:** + +4. **Configure your environment:** + ```bash cp .env.example .env # Now, edit the .env file with your MT5 credentials ``` -5. **Run the application:** + +5. **Run the application:** + ```bash python run.py ``` -6. **Development & Testing (Optional):** + +6. **Development & Testing (Optional):** + ```bash # Explore 30+ test scripts in testing/ directory # Test specific strategies, brokers, or market conditions @@ -253,6 +284,7 @@ DB_NAME=bots.db Since MetaTrader 5 is Windows-only software, Linux users need to use Wine to run MT5. Here's a step-by-step guide: ### 1. Install Wine + ```bash # Ubuntu/Debian sudo apt update @@ -266,6 +298,7 @@ sudo pacman -S wine winetricks ``` ### 2. Configure Wine Environment + ```bash # Create a new Wine prefix for MT5 (recommended for isolation) export WINEPREFIX="$HOME/.wine-mt5" @@ -276,6 +309,7 @@ winetricks corefonts vcrun2019 dotnet48 ``` ### 3. Download and Install MetaTrader 5 + ```bash # Download MT5 installer from your broker's website # Example for XM Global: @@ -286,6 +320,7 @@ wine xmglobal5setup.exe ``` ### 4. Configure Python Environment + ```bash # Set up the project as usual git clone https://github.com/rebarakaz/quantumbotx.git @@ -300,6 +335,7 @@ cp .env.example .env ``` ### 5. Run QuantumBotX with Wine + ```bash # Start MT5 in Wine (in background) export WINEPREFIX="$HOME/.wine-mt5" @@ -310,13 +346,16 @@ python run.py ``` ### 6. Troubleshooting Tips + - **MT5 Connection Issues**: Ensure MT5 is fully loaded before starting QuantumBotX - **Wine Performance**: Use `winecfg` to adjust graphics settings for better performance - **Font Issues**: Install additional fonts with `winetricks corefonts` - **Memory Issues**: Increase Wine's virtual memory in `winecfg` ### Alternative: Docker Approach + For advanced users, you can also run MT5 in a Windows container: + ```bash # This requires Docker with Windows container support # Implementation details depend on your specific setup @@ -329,6 +368,7 @@ For advanced users, you can also run MT5 in a Windows container: ## ๐Ÿ–ฅ๏ธ System Requirements ### Windows (Native Support) + - Windows 10/11 (64-bit recommended) - MetaTrader 5 terminal - Python 3.10 or higher @@ -336,6 +376,7 @@ For advanced users, you can also run MT5 in a Windows container: - Stable internet connection ### Linux (Wine Required) + - Any modern Linux distribution - Wine 6.0 or higher - Python 3.10 or higher @@ -343,6 +384,7 @@ For advanced users, you can also run MT5 in a Windows container: - X11 or Wayland display server ### macOS (Not Officially Supported) + - macOS users may attempt Wine/CrossOver setup - Consider using Windows VM or Parallels - Not recommended for production trading @@ -360,18 +402,22 @@ This software is provided "as is" for educational and research purposes. The aut ## ๐Ÿ“ˆ Screenshot ### Dashboard Preview + Main dashboard showing bot status, performance metrics, and quick access to all features. ![QuantumBotX Dashboard Preview](static/img/dashboard-preview.png) ### Demo Account View + Example of a demo trading account with risk management settings and strategy configuration. ### Strategy Configuration + Interface for setting up and customizing trading strategies with ATR-based risk management. ![Strategy Configuration](static/img/strategy-configuration.png) ### Backtesting Results + Visualization of strategy performance with interactive charts and detailed metrics. ![Backtesting Results](static/img/backtesting-results.png) @@ -388,7 +434,7 @@ Concept, Logic & Execution: `@chrisnov` aka BabyDev If you like this project, give it a โญ on GitHub, or buy me a coffee to support future versions: -[Donate with PayPal](https://www.paypal.com/paypalme/rebarakaz) +[img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="Donate with PayPal"](https://www.paypal.com/paypalme/rebarakaz) --- diff --git a/README_NEW.md b/README_NEW.md index 049f810..0828ca0 100644 --- a/README_NEW.md +++ b/README_NEW.md @@ -9,6 +9,7 @@ Welcome to **QuantumBotX**, your personal, modular, and smart trading assistant **New to QuantumBotX?** Follow these 3 simple steps: ### โšก Step 1: Install MT5 Integration + ```bash # Automatically detect, install, and configure MT5 python install_mt5_integration.py @@ -22,6 +23,7 @@ python install_mt5_integration.py ``` ### ๐Ÿฆ Step 2: Setup MT5 Platform + ```bash # 1. Download MT5 from: https://www.metatrader5.com/en/download # 2. Install with default settings @@ -30,6 +32,7 @@ python install_mt5_integration.py ``` ### โš™๏ธ Step 3: Configure & Test + ```bash # Edit your .env file with MT5 credentials: # MT5_LOGIN=your_account_number @@ -47,6 +50,7 @@ python run.py ``` ### โ“ Need Help? + - ๐Ÿ“– **Full Guide**: Check `MT5_SETUP_GUIDE.md` - ๐Ÿงช **Quick Test**: `python test_mt5_connection.py` - ๐Ÿ”ง **Manual Config**: Edit `.env` file directly @@ -56,24 +60,28 @@ python run.py ## ๐ŸŽฏ Key Features ### ๐Ÿ“Š **Professional Backtesting** + - **MT5 Data Integration**: Download 50+ instruments directly from brokers - **Realistic Modeling**: Spread, slippage, and commission simulation - **Strategy Testing**: 16+ strategies with custom parameters - **Performance Analytics**: Equity curves, drawdown analysis, risk metrics ### ๐Ÿง  **Smart Bot Management** + - **Real-Time Monitoring**: Live bot status with auto-refresh - **Risk Protection**: Ultra-safe position sizing, especially for gold/XAUUSD - **Strategy Switching**: Automated strategy adaptation to market conditions - **Multi-Broker Support**: XM Global, FBS, Exness, IC Markets, Pepperstone ### ๐Ÿ” **Market Analysis** + - **Live Data Analysis**: Real-time signals from MT5 market data - **Multi-Timeframe**: Daily, H1, M15 analysis for comprehensive signals - **Holiday Detection**: Automatic Christmas/Ramadan mode activation - **AI Mentor**: Personalized trading guidance in Indonesian ### ๐Ÿ” **Safety First** + - **Conservative Defaults**: Beginner-safe settings out of the box - **Account Protection**: Emergency brakes and risk limits - **Testing Mode**: Demo account support before live trading @@ -84,6 +92,7 @@ python run.py ## ๐Ÿ—‚๏ธ Data Download Features ### Available Instruments + - **Forex**: EURUSD, GBPUSD, AUDUSD, JPY pairs, major crosses - **Gold**: XAUUSD with ultra-conservative risk management - **Indices**: US30, US100, US500 (S&P 500), DE30, UK100 @@ -92,12 +101,14 @@ python run.py - **Exotic Pairs**: Currency pairs for advanced traders ### Data Quality + - โœ… **4+ Years** of historical data - โœ… **OHLCV Format**: Open, High, Low, Close, Volume - โœ… **Broker Aliasing**: Automatic XAUUSD/USDIDR variant detection - โœ… **Timeframes**: H1 (recommended), M1, M5, M15, H4, D1 ### Download Methods + 1. **Web Interface**: Click "Download Data MT5" button on backtesting page 2. **Command Line**: `python lab/download_data.py` 3. **Automatic Installer**: `python install_mt5_integration.py` @@ -129,18 +140,21 @@ python run.py ## ๐Ÿ“š Educational Framework ### Beginner Path (Month 1) + - **Week 1**: MA Crossover on EURUSD - **Week 2**: Bollinger Bands for range trading - **Week 3**: Basic risk management practices - **Week 4**: Understanding ATR-based position sizing ### Intermediate Path (Month 2-3) + - **Strategy Rotation**: Multiple approaches per market - **Parameter Optimization**: Finding edge through testing - **Market Analysis**: Understanding different market regimes - **Risk Scaling**: Position sizing based on confidence ### Advanced Mastery (Month 4+) + - **Strategy Combination**: Multi-strategy portfolios - **Market Timing**: When to trade what - **Risk Management**: Advanced portfolio protection @@ -151,12 +165,14 @@ python run.py ## โš ๏ธ Important Disclaimers **Trading Risks:** + - FX trading involves substantial risk and may not be suitable for all - High leverage can amplify losses - Past performance โ‰  future results - Never trade with money you can't afford to lose **Software Usage:** + - For educational/research purposes - Test thoroughly on demo accounts first - Creator not responsible for trading losses @@ -176,6 +192,7 @@ python run.py ## ๐Ÿ“ˆ What's Next? ### Current Features โœ… + - โœ… MT5 Integration with 50+ instruments - โœ… 16 Trading strategies with risk management - โœ… AI mentor in Indonesian @@ -184,6 +201,7 @@ python run.py - โœ… Ultra-conservative gold/XAUUSD protection ### Coming Soon ๐Ÿšง + - ๐Ÿ”„ Telegram notifications - ๐Ÿ”„ Advanced portfolio analytics - ๐Ÿ”„ Multi-broker arbitrage @@ -196,8 +214,8 @@ python run.py Enjoy QuantumBotX? Consider supporting future development: -[Donate with PayPal](https://www.paypal.com/paypalme/rebarakaz) +[img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="Donate with PayPal"](https://www.paypal.com/paypalme/rebarakaz) --- -*Happy Trading! ๐ŸŽฏ๐Ÿ“Š๐Ÿ†* +Happy Trading! ๐ŸŽฏ๐Ÿ“Š๐Ÿ† diff --git a/README_STREAMLIT.md b/README_STREAMLIT.md index 3571b85..0126506 100644 --- a/README_STREAMLIT.md +++ b/README_STREAMLIT.md @@ -6,7 +6,8 @@ Since MetaTrader 5 requires **Windows OS and persistent terminal connections**, ## Why Streamlit Demo? -### โœ… Advantages: +### โœ… Advantages + - **No MT5 Dependency**: Works on any cloud platform (Railway, Vercel, Heroku, etc.) - **Interactive Demo**: Realistic trading simulation with live data - **Easy Deployment**: Single command deployment with pip installs @@ -14,7 +15,8 @@ Since MetaTrader 5 requires **Windows OS and persistent terminal connections**, - **Cost Effective**: Free tier available on most platforms - **Fast Loading**: Lightweight compared to full Flask app -### โŒ Limitations: +### โŒ Limitations + - No live trading execution (by design for safety) - Simulated data only - No MT5 integration @@ -27,11 +29,13 @@ Since MetaTrader 5 requires **Windows OS and persistent terminal connections**, 1. **Create Account**: Go to [share.streamlit.io](https://share.streamlit.io) 2. **Connect Repository**: Link your GitHub account 3. **Deploy**: + ```bash git add streamlit_demo.py streamlit_requirements.txt git commit -m "Add Streamlit demo for QuantumBotX" git push origin main ``` + 4. **Configuration**: - Main file path: `streamlit_demo.py` - Requirements file: `streamlit_requirements.txt` @@ -39,11 +43,13 @@ Since MetaTrader 5 requires **Windows OS and persistent terminal connections**, ### Option 2: Railway + Streamlit 1. **Initialize Railway Project**: + ```bash railway init ``` 2. **Create Railway Configuration**: + ```bash # railway.toml [build] @@ -57,6 +63,7 @@ Since MetaTrader 5 requires **Windows OS and persistent terminal connections**, - No MT5 credentials needed (demo only) 4. **Deploy**: + ```bash git add . git commit -m "Add Railway config for Streamlit demo" @@ -67,6 +74,7 @@ Since MetaTrader 5 requires **Windows OS and persistent terminal connections**, ### Option 3: Heroku + Streamlit 1. **Create Heroku App**: + ```bash heroku create quantum-botx-demo ``` @@ -80,6 +88,7 @@ Since MetaTrader 5 requires **Windows OS and persistent terminal connections**, ``` 4. **Deploy**: + ```bash git push heroku main ``` @@ -87,6 +96,7 @@ Since MetaTrader 5 requires **Windows OS and persistent terminal connections**, ### Option 4: Vercel + Streamlit (Experimental) 1. **Create vercel.json**: + ```json { "version": 2, @@ -106,25 +116,29 @@ Since MetaTrader 5 requires **Windows OS and persistent terminal connections**, ``` 2. **Deploy**: + ```bash vercel --prod ``` ## Demo Features Showcased -### ๐Ÿ“Š Interactive Dashboard: +### ๐Ÿ“Š Interactive Dashboard + - **Live Metrics**: Balance, strategies, profits, bots running - **Strategy Showcase**: MA Crossover & Bollinger Band explanations - **Charts**: Example price movements with indicators - **Trading History**: Filtered historic demo trades -### ๐ŸŽฏ Strategy Highlights: +### ๐ŸŽฏ Strategy Highlights + - **Beginner Friendly**: Clear explanations and examples - **Risk Management**: ATR-based sizing demonstrations - **Multi-Asset**: FOREX, Gold, Crypto, Indices examples - **AI Features**: Strategy complexity ratings, mentor system -### ๐Ÿš€ Professional Presentation: +### ๐Ÿš€ Professional Presentation + - **Clean UI**: Modern Streamlit interface - **Responsive Design**: Works on mobile and desktop - **Educational Content**: Feature explanations and guides @@ -152,18 +166,21 @@ streamlit run streamlit_demo.py ## Deployment Commands -### Streamlit Cloud (Recommended): +### Streamlit Cloud (Recommended) + ```bash streamlit run streamlit_demo.py --server.port 8501 --server.headless false ``` -### Railway: +### Railway + ```bash railway init railway up ``` -### Heroku: +### Heroku + ```bash heroku create your-app-name git push heroku main @@ -172,7 +189,7 @@ git push heroku main ## Cost Comparison | Platform | Free Tier | Cost for Demo | Best For | -|----------|-----------|---------------|----------| +| -------- | --------- | ------------- | -------- | | **Streamlit Cloud** | 100 hours/month | Free | Best choice | | **Railway** | $5/month | $5/month | Good alternative | | **Heroku** | 550 hours/month | Free | Simple option | @@ -180,14 +197,15 @@ git push heroku main ## Why Not Live Trading Deployment? -### Technical Barriers: +### Technical Barriers 1. **MT5 Windows-Only**: Terminal requires Windows OS 2. **Persistent Connection**: Needs continuous MT5 session 3. **GUI Requirement**: MT5 needs display server for login 4. **License Issues**: MT5 EULA may prohibit containerization -### Railway Specifically: +### Railway Specifically + - Railway uses **Linux containers** (Ubuntu/CentOS) - **Wine complications**: MT5 + Wine = unreliable connections - **No Windows support**: Railway doesn't offer Windows containers @@ -210,4 +228,4 @@ git push heroku main --- -**Happy Showcasing! ๐ŸŽฏ๐Ÿค–** +Happy Showcasing! ๐ŸŽฏ๐Ÿค– diff --git a/ROADMAP.md b/ROADMAP.md index 00ae0d9..e0a6412 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -5,17 +5,20 @@ ## ๐ŸŽฏ **What's Coming Next** ### **Q4 2025: Intelligence Enhancement** + - **Advanced AI Features**: Enhanced strategy analysis with machine learning - **Real-time Notifications**: Telegram integration for trade alerts - **Portfolio Analytics**: Advanced performance dashboards - **Enterprise Features**: Multi-account management and compliance logging ### **Exciting New Project** ๐Ÿš€ + We're developing **QuantumBotX API** - a revolutionary cloud-based trading platform that will give users unprecedented freedom: > **"Trade anywhere, anytime, with any broker - no local installations required!"** **QuantumBotX API will feature:** + - ๐ŸŒ **Cloud-native architecture** - Run on any device, anywhere - ๐Ÿ”„ **Direct broker integration** - No intermediaries, pure API trading - ๐ŸŒ **Cross-broker support** - IC Markets, Pepperstone, and beyond @@ -23,6 +26,7 @@ We're developing **QuantumBotX API** - a revolutionary cloud-based trading platf - ๐ŸŽ“ **Advanced education** - Built-in learning with community support ### **Timeline** + - **Q4 2025**: Closed beta testing with select users - **Q1 2026**: Public beta launch with premium support - **Q2 2026**: Full global launch with subscription tiers @@ -48,4 +52,4 @@ We're developing **QuantumBotX API** - a revolutionary cloud-based trading platf --- -**Roadmap Updated: September 2025** +Roadmap Updated: September 2025*