Crypto-MX2

Crypto-MX

A Multi-Modal Explainable AI (XAI) system for cryptocurrency price forecasting.

Getting Started

Prerequisites

• Python 3.8+
• Node.js & npm
• Git

Installation

1. Backend:

   # Create virtual environment
   python -m venv venv
   # Activate virtual environment
   .\venv\Scripts\Activate
   # Install dependencies
   pip install -r requirements.txt
   

2. Frontend:

   # Install dependencies
   npm install
   npm install
   

🚀 Easy Start (Windows)

Simply double-click start_app.bat to launch both the backend and frontend automatically!

Manual Running

1. Backend (API)

Start the backend API server which serves the machine learning models and data:

# Ensure you are in the root directory and your venv is activated
python main.py api

The API will be available at http://127.0.0.1:8000.

2. Frontend (UI)

Start the frontend development server:

# Open a new terminal
npm run dev

The frontend will typically run at http://localhost:5173 (check the terminal output).

Project Structure

• main.py: Main entry point for backend commands (data collection, training, api).
• src/: Backend source code.
• index.html & vite.config.ts: Frontend entry points.

Other Backend Commands

• Check Setup: python main.py setup
• Data Collection:
  • python main.py market (Collect Binance data)
  • python main.py social (Collect social data)
  • python main.py onchain (Collect on-chain data)
• Training: python main.py train