# virajsavaliya/crypto-tracker architecture

> Architecture diagram of the GitHub repository virajsavaliya/crypto-tracker, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/virajsavaliya/crypto-tracker
- Repository: https://github.com/virajsavaliya/crypto-tracker

## Overview

VoluSignal scans Binance markets, calculates multi-timeframe trading metrics, and presents them in a live dashboard; users can also configure alerts, connect Telegram, and manage subscription plans. The main flow is market ingestion and background processing into persistent data, then WebSocket delivery to the dashboard. The README documents REST, billing, and Telegram capabilities beyond the sampled excerpts; those branches are included, but their specific runtime wiring is not fully visible in the sampled source.

Main entry points: [`backend/core/views.py`](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/views.py) (REST API), [`backend/core/tasks.py`](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/tasks.py) (Background Tasks), [`backend/core/consumers.py`](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/consumers.py) (WebSocket Consumer), [`backend/core/models.py`](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/models.py) (Domain Models)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web Client"]
  node_dashboard["Market Dashboard<br/>[page.tsx]"]
  node_alert_ui["Alert Management<br/>[page.tsx]"]
  node_plan_ui["Plans and Settings<br/>[page.tsx]"]
end

subgraph group_market["Market Data"]
  node_ingest["Market Ingestion<br/>[start_websocket.py]"]
  node_realtime["Binance Data Client"]
  node_analytics["Trading Analytics"]
  node_tasks["Background Tasks<br/>[tasks.py]"]
end

subgraph group_backend["Application Services"]
  node_api["REST API<br/>[views.py]"]
  node_ws["WebSocket Consumer<br/>[consumers.py]"]
  node_serializers["API Serializers<br/>[serializers.py]"]
  node_celery["Task Scheduler<br/>[celery.py]"]
end

subgraph group_messaging["Alerts and Messaging"]
  node_telegram["Telegram Bot<br/>[telegram_bot.py]"]
end

subgraph group_data["State and Storage"]
  node_models["Domain Models<br/>[models.py]"]
  node_postgres[("PostgreSQL")]
  node_redis[("Redis Channels and Cache")]
end

node_user(("Trader"))
node_binance{{"Binance Market Feed"}}
node_telegram_api{{"Telegram Bot API"}}
node_stripe{{"Stripe Billing"}}

node_user -->|"views"| node_dashboard
node_user -->|"configures alerts"| node_alert_ui
node_user -->|"manages plan"| node_plan_ui
node_binance -->|"streams tickers"| node_ingest
node_binance -->|"provides market data"| node_realtime
node_ingest -.->|"stores market data"| node_postgres
node_ingest -.->|"publishes updates"| node_redis
node_realtime -.->|"supplies metrics input"| node_analytics
node_tasks -->|"runs dashboard"| node_analytics
node_celery -->|"schedules tasks"| node_tasks
node_tasks -->|"dispatches alerts"| node_telegram
node_tasks -->|"evaluates alert rules"| node_models
node_api -.->|"reads and writes"| node_models
node_api -->|"handles billing"| node_stripe
node_ws -->|"reads snapshots"| node_models
node_ws -->|"serializes snapshots"| node_serializers
node_ws -->|"uses channel layer"| node_redis
node_dashboard -->|"receives live stream"| node_ws
node_dashboard -.->|"requests REST data"| node_api
node_alert_ui -.->|"manages alert rules"| node_api
node_plan_ui -.->|"requests plan data"| node_api
node_models -->|"persists domain data"| node_postgres
node_telegram -->|"sends bot messages"| node_telegram_api

click node_dashboard "https://github.com/virajsavaliya/crypto-tracker/blob/main/frontend/src/app/dashboard/page.tsx"
click node_alert_ui "https://github.com/virajsavaliya/crypto-tracker/blob/main/frontend/src/app/alerts/page.tsx"
click node_plan_ui "https://github.com/virajsavaliya/crypto-tracker/blob/main/frontend/src/app/plan-management/page.tsx"
click node_ingest "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/management/commands/start_websocket.py"
click node_realtime "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/binance_realtime.py"
click node_analytics "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/crypto_trading_dashboard.py"
click node_tasks "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/tasks.py"
click node_api "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/views.py"
click node_ws "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/consumers.py"
click node_serializers "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/serializers.py"
click node_celery "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/project_config/celery.py"
click node_models "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/models.py"
click node_telegram "https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/telegram_bot.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_dashboard,node_alert_ui,node_plan_ui toneBlue
class node_ingest,node_realtime,node_analytics,node_tasks toneAmber
class node_api,node_ws,node_serializers,node_celery,node_telegram_api toneMint
class node_telegram toneRose
class node_models,node_postgres,node_redis,node_user,node_binance,node_stripe toneIndigo
```

## Components

### Web Client

- [Market Dashboard](https://github.com/virajsavaliya/crypto-tracker/blob/main/frontend/src/app/dashboard/page.tsx): `frontend/src/app/dashboard/page.tsx`
- [Alert Management](https://github.com/virajsavaliya/crypto-tracker/blob/main/frontend/src/app/alerts/page.tsx): `frontend/src/app/alerts/page.tsx`
- [Plans and Settings](https://github.com/virajsavaliya/crypto-tracker/blob/main/frontend/src/app/plan-management/page.tsx): `frontend/src/app/plan-management/page.tsx`

### Market Data

- [Market Ingestion](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/management/commands/start_websocket.py): `backend/core/management/commands/start_websocket.py`
- [Binance Data Client](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/binance_realtime.py): `backend/core/binance_realtime.py`
- [Trading Analytics](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/crypto_trading_dashboard.py): `backend/core/crypto_trading_dashboard.py`
- [Background Tasks](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/tasks.py): `backend/core/tasks.py`

### Application Services

- [REST API](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/views.py): `backend/core/views.py`
- [WebSocket Consumer](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/consumers.py): `backend/core/consumers.py`
- [API Serializers](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/serializers.py): `backend/core/serializers.py`
- [Task Scheduler](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/project_config/celery.py): `backend/project_config/celery.py`

### Alerts and Messaging

- [Telegram Bot](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/telegram_bot.py): `backend/core/telegram_bot.py`

### State and Storage

- [Domain Models](https://github.com/virajsavaliya/crypto-tracker/blob/main/backend/core/models.py): `backend/core/models.py`
- **PostgreSQL**
- **Redis Channels and Cache**

### Other components

- **Trader**
- **Binance Market Feed**
- **Telegram Bot API**
- **Stripe Billing**

## Connections

- Trader → Market Dashboard: views (evidence: `README.md`)
- Trader → Alert Management: configures alerts (evidence: `README.md`)
- Trader → Plans and Settings: manages plan (evidence: `README.md`)
- Binance Market Feed → Market Ingestion: streams tickers (evidence: `README.md`)
- Binance Market Feed → Binance Data Client: provides market data (evidence: `backend/core/binance_realtime.py`)
- Market Ingestion → PostgreSQL: stores market data
- Market Ingestion → Redis Channels and Cache: publishes updates
- Binance Data Client → Trading Analytics: supplies metrics input
- Background Tasks → Trading Analytics: runs dashboard (evidence: `backend/core/tasks.py`)
- Task Scheduler → Background Tasks: schedules tasks (evidence: `backend/project_config/celery.py`)
- Background Tasks → Telegram Bot: dispatches alerts (evidence: `backend/core/tasks.py`)
- Background Tasks → Domain Models: evaluates alert rules (evidence: `backend/core/tasks.py`)
- REST API → Domain Models: reads and writes
- REST API → Stripe Billing: handles billing (evidence: `README.md`)
- WebSocket Consumer → Domain Models: reads snapshots (evidence: `backend/core/consumers.py`)
- WebSocket Consumer → API Serializers: serializes snapshots (evidence: `backend/core/consumers.py`)
- WebSocket Consumer → Redis Channels and Cache: uses channel layer (evidence: `README.md`)
- Market Dashboard → WebSocket Consumer: receives live stream (evidence: `README.md`)
- Market Dashboard → REST API: requests REST data
- Alert Management → REST API: manages alert rules
- Plans and Settings → REST API: requests plan data
- Domain Models → PostgreSQL: persists domain data (evidence: `README.md`)
- Telegram Bot → Telegram Bot API: sends bot messages (evidence: `backend/core/telegram_bot.py`)
