gavindiaz/quantumbotx
1
0
Fork 0
mirror of https://github.com/chrisnov-it/quantumbotx.git synced 2026-08-01 05:07:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md with enhanced features, roadmap, and setup instructions

Browse Source 
- Expanded feature descriptions for clarity
- Added roadmap section outlining future developments
- Improved local setup instructions for better readability
- Updated environment variable notes and removed deprecated API references
This commit is contained in:
Reynov Christian
2025-08-01 01:42:11 +08:00
parent a1d6f444fc
commit 52876981b0
1 changed files with 73 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+73 -46
View File
@@ -1,84 +1,112 @@
## 📄 `README.md` for QuantumBotX
````markdown
# 🤖 QuantumBotX — AI-Powered Modular Trading Bot for MT5
Welcome to **QuantumBotX**, your personal, modular, and smart trading assistant built with 💖 using Python and MetaTrader5 (MT5).
!MIT License
!Python Version
!Framework
!Made with Love
Welcome to **QuantumBotX**, your personal, modular, and smart trading assistant built with Python and MetaTrader5 (MT5).
Designed to be elegant, powerful, and flexible — whether you're a scalper, swing trader, or a strategy researcher.
---
## 🚀 Features
- ✅ Modular Strategy System (`MA_CROSSOVER`, `RSI_POP`, and more)
- ✅ Real-Time Price & RSI Analysis (with beautiful Chart.js dashboard)
- ✅ Auto Position Handling (entry, exit, stop loss, take profit)
- ✅ Logging to SQLite (`trade_history`, `notifications`)
- ✅ Dashboard UI built with Flask + TailwindCSS
- ✅ Multiple Timeframes supported
- ✅ Ready for Live or Demo accounts
- ✅ **Modular Strategy System**: Easily create and plug in your own trading strategies.
- ✅ **Real-Time Analysis**: Live dashboard with data visualization using Chart.js.
- ✅ **Adaptive Logic**: Comes with a Hybrid strategy that adapts to trending or ranging markets.
- ✅ **Automated Trading**: Full position handling (entry, exit, SL, TP) using bot-specific magic numbers.
- ✅ **Persistent Logging**: All activities and trades are logged to a local SQLite database.
- ✅ **Modern Web UI**: Clean and responsive dashboard built with Flask and TailwindCSS.
- ✅ **Multi-Timeframe Support**: Analyze and trade on any standard timeframe from M1 to D1.
- ✅ **Live/Demo Ready**: Tested and ready for both demo and live trading accounts.
---
## 📦 Tech Stack
- `Python 3.10+`
- `Flask`
- `MetaTrader5 (MetaQuotes)`
- `pandas + pandas_ta`
- `Chart.js`
- `SQLite`
- *(Optional APIs: Alpha Vantage, CMC, Finnhub – deprecated soon)*
- `Flask` & `TailwindCSS`
- `MetaTrader5` Python Integration
- `pandas` & `pandas-ta` for data analysis
- `Chart.js` for data visualization
- `SQLite` for database
---
## 🧠 Strategy Examples
| Strategy | Description |
|------------------|-----------------------------------------|
| `MA_CROSSOVER` | Classic Golden/Death Cross with filter |
| `RSI_POP` | RSI Breakout based momentum scalping |
| `MACD_STOCH_FILTER` | Advanced filtered entry (coming soon) |
| Strategy | Description | Best For |
|---|---|---|
| `Moving Average Crossover` | Classic Golden/Death Cross. | Trending markets (e.g., Indices, XAUUSD). |
| `Bollinger Bands Reversion` | Mean reversion based on price touching the bands. | Ranging/Volatile markets (e.g., EURUSD). |
| `QuantumBotX Hybrid` | Adaptive strategy using ADX to switch between MA Crossover and Bollinger Bands. | All-weather performance. |
---
## 📈 Roadmap
- [ ] **Advanced Strategy**: `MACD_STOCH_FILTER` for more precise, filtered entries.
- [ ] **Backtesting Module**: A simple UI to test strategies against historical data.
- [ ] **Telegram Notifications**: Get real-time alerts for trades and errors.
- [ ] **Portfolio Analytics**: Deeper insights into your trading performance.
---
## 🔐 Environment Variables (`.env`)
Rename `.env.example` → `.env`, and fill in the following:
Rename `.env.example` to `.env`, and fill in the following:
```env
MT5_LOGIN="your_mt5_login"
MT5_PASSWORD="your_password"
MT5_SERVER=MetaQuotes-Demo
MT5_SERVER="your_broker_server"
SECRET_KEY="any_flask_secret_key"
DB_NAME=bots.db
````
You can ignore:
```env
ALPHA_VANTAGE_KEY=
CMC_API_KEY=
FINNHUB_KEY=
```
> These APIs will be removed in future versions.
> **Note:** The API keys for Alpha Vantage, CMC, and Finnhub are deprecated and can be ignored.
---
## 🧪 Local Setup (Dev Mode)
```bash
git clone https://github.com/rebarakaz/quantumbotx.git
cd quantumbotx
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cp .env.example .env
python app.py
```
1. **Clone the repository:**
```bash
git clone https://github.com/rebarakaz/quantumbotx.git
cd quantumbotx
```
2. **Set up Python virtual environment:**
```bash
python -m venv venv
# On Windows
.\venv\Scripts\activate
# On macOS/Linux
source venv/bin/activate
```
3. **Install dependencies:**
```bash
pip install -r requirements.txt
```
4. **Configure your environment:**
```bash
cp .env.example .env
# Now, edit the .env file with your MT5 credentials
```
5. **Run the application:**
```bash
python app.py
```
> You must have MetaTrader 5 installed and configured locally.
> **Important:** You must have the MetaTrader 5 terminal installed and running on the same machine.
---
## ⚠️ Disclaimer
Trading foreign exchange on margin carries a high level of risk and may not be suitable for all investors. The high degree of leverage can work against you as well as for you. Before deciding to trade, you should carefully consider your investment objectives, level of experience, and risk appetite.
This software is provided "as is" for educational and research purposes. The author is not responsible for any financial losses incurred from using this bot. **Always test thoroughly on a demo account before using on a live account.**
---
@@ -108,6 +136,5 @@ USDT TRC20: TRxxxxxxxxxxxx
## 📝 License
MIT — feel free to fork, build on top, or deploy your own!
```
This project is licensed under the MIT License - see the LICENSE.md file for details.
```bash