Quick Start

Deploy SkySpy using Docker Compose in under 5 minutes.

%%{init: {'theme': 'dark', 'themeVariables': { 'primaryColor': '#1e3a5f', 'primaryTextColor': '#fff', 'primaryBorderColor': '#3b82f6', 'lineColor': '#60a5fa'}}}%%
flowchart LR
    A["📥 Clone Repo"] --> B["⚙️ Configure .env"]
    B --> C["🐳 Docker Compose Up"]
    C --> D["🖥️ Open Dashboard"]

    style A fill:#0d4f8b,stroke:#3b82f6,stroke-width:2px,color:#fff
    style B fill:#7c4a03,stroke:#f59e0b,stroke-width:2px,color:#fff
    style C fill:#065f46,stroke:#10b981,stroke-width:2px,color:#fff
    style D fill:#5b2168,stroke:#a855f7,stroke-width:2px,color:#fff

Prerequisites

Installation

Access the Dashboard

Once the containers are running, you can access:

What You'll See

%%{init: {'theme': 'dark', 'themeVariables': { 'primaryColor': '#1e3a5f', 'primaryTextColor': '#fff', 'primaryBorderColor': '#3b82f6', 'lineColor': '#60a5fa'}}}%%
flowchart TB
    subgraph Dashboard["🖥️ Web Dashboard"]
        direction LR
        RADAR["🗺️ Radar Display"]
        LIST["📋 Aircraft List"]
        DETAIL["✈️ Aircraft Details"]
    end

    subgraph Data["📡 Live Data"]
        POS["📍 Position Updates"]
        SAFE["🛡️ Safety Alerts"]
        WX["🌦️ Weather Data"]
    end

    Data --> Dashboard

    style Dashboard fill:#065f46,stroke:#10b981,stroke-width:2px,color:#fff
    style Data fill:#0d4f8b,stroke:#3b82f6,stroke-width:2px,color:#fff

The dashboard shows:

• Radar Display — Aircraft positions on an interactive map
• Aircraft List — Sortable table of all tracked aircraft
• Detail Panel — Click any aircraft for photos, flight info, and track history
• Safety Alerts — Real-time notifications for TCAS, proximity, and emergencies

Troubleshooting

Local Development

For contributors who want to run services without Docker:

cd adsb-api
pip install -e ".[dev]"
uvicorn app.main:app --host 0.0.0.0 --port 5000 --reload

Deployment Checklist

Next Steps