Files
quantumbotx/README_STREAMLIT.md
T
Reynov Christian 72bcc1f284 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.
2025-12-24 13:01:42 +08:00

5.7 KiB

🚀 QuantumBotX Streamlit Demo Deployment Guide

Overview

Since MetaTrader 5 requires Windows OS and persistent terminal connections, enabling Railway or other cloud platforms for live trading is not technically feasible. However, for public demonstration purposes, we've created a beautiful Streamlit demo that showcases all QuantumBotX features without requiring MT5.

Why Streamlit Demo?

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
  • Public Showcase: Perfect for demonstrating capabilities to potential users
  • Cost Effective: Free tier available on most platforms
  • Fast Loading: Lightweight compared to full Flask app

Limitations

  • No live trading execution (by design for safety)
  • Simulated data only
  • No MT5 integration
  • Read-only demonstration

Quick Deployment Options

Option 1: Streamlit Cloud (Easiest)

  1. Create Account: Go to share.streamlit.io

  2. Connect Repository: Link your GitHub account

  3. Deploy:

    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

Option 2: Railway + Streamlit

  1. Initialize Railway Project:

    railway init
    
  2. Create Railway Configuration:

    # railway.toml
    [build]
    builder = "NIXPACKS"
    
    [deploy]
    startCommand = "streamlit run streamlit_demo.py --server.port $PORT --server.headless true"
    
  3. Environment Variables (optional):

    • No MT5 credentials needed (demo only)
  4. Deploy:

    git add .
    git commit -m "Add Railway config for Streamlit demo"
    git push origin main
    railway up
    

Option 3: Heroku + Streamlit

  1. Create Heroku App:

    heroku create quantum-botx-demo
    
  2. Create requirements.txt (use streamlit_requirements.txt)

  3. Create Procfile:

    web: streamlit run streamlit_demo.py --server.port $PORT --server.headless true
    
  4. Deploy:

    git push heroku main
    

Option 4: Vercel + Streamlit (Experimental)

  1. Create vercel.json:

    {
      "version": 2,
      "builds": [
        {
          "src": "streamlit_demo.py",
          "use": "@vercel/python"
        }
      ],
      "routes": [
        {
          "src": "/(.*)",
          "dest": "streamlit_demo.py"
        }
      ]
    }
    
  2. Deploy:

    vercel --prod
    

Demo Features Showcased

📊 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

  • 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

  • Clean UI: Modern Streamlit interface
  • Responsive Design: Works on mobile and desktop
  • Educational Content: Feature explanations and guides
  • Call-to-Action: Download links and system requirements

Files Created

  • streamlit_demo.py: Complete demo application
  • streamlit_requirements.txt: Minimal dependencies for cloud deployment
  • README_STREAMLIT.md: This deployment guide

Testing Locally

Before deploying, test the demo locally:

# Install dependencies
pip install -r streamlit_requirements.txt

# Run the demo
streamlit run streamlit_demo.py

Expected Result: Demo app opens in browser showing QuantumBotX features

Deployment Commands

streamlit run streamlit_demo.py --server.port 8501 --server.headless false

Railway

railway init
railway up

Heroku

heroku create your-app-name
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
Vercel Generous free Free If preferring Vercel

Why Not Live Trading Deployment?

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 uses Linux containers (Ubuntu/CentOS)
  • Wine complications: MT5 + Wine = unreliable connections
  • No Windows support: Railway doesn't offer Windows containers
  • Cost ineffective: Persistent VMs for MT5 would be expensive

Next Steps

  1. Choose Platform: Streamlit Cloud for easiest deployment
  2. Test Demo: Run locally first
  3. Deploy: Push to chosen platform
  4. Share: Send demo link to potential users
  5. Monitor: Check analytics and user feedback

Support

  • Demo Issues: Test locally first, then check deployment logs
  • Streamlit Docs: docs.streamlit.io
  • Platform Support: Each platform has detailed documentation
  • QuantumBotX: Full version requires Windows + MT5 setup

Happy Showcasing! 🎯🤖