aprs.me/docs/README.md

41 lines
1.7 KiB
Markdown

# aprs.me Documentation
APRS packet visualization and tracking platform built with Phoenix LiveView + PostGIS.
## Architecture
- [Architecture Overview](architecture/overview.md) — System components, data flow, and design decisions
- [Ingestion Pipeline](architecture/ingestion-pipeline.md) — APRS-IS → GenStage → Postgres → PubSub broadcast
## Domain Contexts
- [Accounts](contexts/accounts.md) — User registration, authentication, session management
- [Packets](contexts/packets.md) — Packet storage, querying, replay, weather, and spatial search
- [Devices](contexts/devices.md) — APRS device identification and registry
## Web Layer
- [LiveView Map](web/liveview-map.md) — MapLive architecture, real-time streaming, components
- [LiveView Pages](web/liveview-pages.md) — Packet streams, weather, status, info, auth pages
- [REST API](web/api-rest.md) — API v1 endpoints (callsign lookup, weather nearby)
- [Mobile WebSocket](web/channels.md) — MobileChannel protocol for iOS/Android apps
## Infrastructure
- [Deployment](infrastructure/deployment.md) — Kubernetes (ArgoCD), Fly.io, Docker, Nix dev shell
- [Observability](infrastructure/observability.md) — PromEx metrics, error tracking, telemetry
## Development
- [Setup Guide](development/setup.md) — Local dev environment, required services, tooling
## Features & Plans
- [Tracked Callsign Behavior](tracked-callsign-behavior.md)
- [Trail Line Visualization](features/trail-line-visualization.md)
- [Plans](plans/) — Design documents and implementation plans
- [Improvement Todos](improvement-todos.md)
## API
- [Mobile API Reference](mobile-api.md) — WebSocket message format for mobile clients