🎯 What is SkySpy?

SkySpy is a comprehensive aircraft tracking platform that processes ADS-B, ACARS, and other aviation data sources. It provides real-time visualization, safety monitoring, custom alerts, and rich analytics.

flowchart LR
    subgraph Input["📡 Data Sources"]
        ADSB[ADS-B<br/>Receivers]
        ACARS[ACARS<br/>Decoders]
    end

    subgraph Core["⚙️ SkySpy"]
        API[Django API]
        WS[Socket.IO]
    end

    subgraph Output["🖥️ Clients"]
        WEB[Web Dashboard]
        CLI[Go CLI]
        EXT[Your App]
    end

    ADSB --> API
    ACARS --> API
    API --> WS
    WS --> WEB
    WS --> CLI
    API --> EXT

📚 Documentation Index

🚀 Getting Started

📘

New to SkySpy? Start here!

🔐 Core Features

🔌 API Reference

💡

Building an integration? These docs are for you.

🧩 Components

✨ Features

🛠️ Operations

👨‍💻 Development

🏃 Quick Commands

# 🐳 Start with Docker
docker compose up -d

# 📊 View logs
docker compose logs -f api

# 🧪 Run tests
docker compose run --rm api pytest

# 🔄 Update
git pull && docker compose up -d --build

🔗 Quick Links

💬 Support

⚠️

Having issues? Check the Troubleshooting Guide first!

• 🐛 Bugs: GitHub Issues
• 💡 Features: GitHub Discussions
• 📧 Contact: [email protected]