Skip to content

README.md

Latest commit

 

History

History
64 lines (50 loc) · 2.38 KB

README.md

File metadata and controls

64 lines (50 loc) · 2.38 KB
Raw

CryptoDash — Real-Time Crypto & Market Data Analytics Engine

CryptoDash ingests live (or replayed) crypto ticks, detects arbitrage opportunities across exchanges, computes rolling metrics, and exposes REST + WebSocket APIs.

Highlights

  • 🧩 Services: ingestor (streams ticks) → analyzer (detects arbitrage, aggregates metrics) → api (FastAPI REST + WebSocket).
  • 🗃️ Infra: Kafka (streams), Postgres (storage), Redis (cache/pubsub), Docker Compose (one command to run).
  • ⚙️ Clean design: typed Python, modular packages, optional C++ core (for algorithms) included in cpp-core/.
  • 🧪 Replay mode: ships with synthetic tick data so you can demo offline.

Architecture

[ Ingestor ] --ticks--> [ Kafka ] --ticks--> [ Analyzer ] --writes--> [ Postgres ]
      |                                                       |--pub--> [ Redis ]
      |                                                                   |
      +-------------------------------------------------------> [ API ] <-+
                                                     REST / WebSocket clients

Quickstart

# start everything
docker compose up -d --build

# API docs
open http://localhost:8000/docs

# Dashboard
open http://localhost:5173

Local dev without Docker

# infra
docker compose up -d kafka zookeeper postgres redis

# analyzer
python -m venv .venv && source .venv/bin/activate
pip install -r services/analyzer/requirements.txt
DATABASE_URL=postgresql+asyncpg://postgres:postgres@localhost:5432/cryptoquant REDIS_URL=redis://localhost:6379 KAFKA_BOOTSTRAP=localhost:29092 python services/analyzer/app.py

# ingestor (replay sample data)
pip install -r services/ingestor/requirements.txt
KAFKA_BOOTSTRAP=localhost:29092 python services/ingestor/app.py

# api
pip install -r services/api/requirements.txt
DATABASE_URL=postgresql+asyncpg://postgres:postgres@localhost:5432/cryptoquant REDIS_URL=redis://localhost:6379 uvicorn services.api.main:app --reload --port 8000

# dashboard
cd webapp && npm install && npm run dev

Web Dashboard (React + Vite)

  • Live Recharts line chart of arbitrage spread (bps)
  • Real-time table of recent signals via WebSocket

Run Dashboard

docker compose up -d --build dashboard
open http://localhost:5173

The dashboard connects to the API at http://localhost:8000 and ws://localhost:8000/ws/arbitrage.