feat: add flight tracking components and hooks
- Introduced FlightCard component for displaying flight information with animations. - Added ScrollArea component for custom scroll behavior. - Implemented StatusBar component to show flight count and loading status. - Created useFlights hook for fetching and managing flight data based on city selection. - Developed useSettings hook for managing user settings with local storage persistence. - Added useTrailHistory hook for managing flight trail data. - Defined City type and CITIES constant for city data management. - Implemented flight utility functions for altitude and speed conversions. - Created map styles for different visual representations. - Added OpenSky API integration for fetching flight data. - Implemented utility functions for class name merging. - Configured TypeScript settings for the project.
This commit is contained in:
84
README.md
Normal file
84
README.md
Normal file
@ -0,0 +1,84 @@
|
||||
# Aeris
|
||||
|
||||
Real-time 3D flight tracking — altitude-aware, visually stunning.
|
||||
|
||||
Aeris renders live air traffic over the world's busiest airspaces on a premium dark-mode map. Flights are separated by altitude in true 3D: low altitudes glow cyan, high altitudes shift to gold. Select a city, and the camera glides to that airspace with spring-eased animation.
|
||||
|
||||
## Stack
|
||||
|
||||
| Layer | Technology |
|
||||
| --------- | ----------------------------------------------- |
|
||||
| Framework | Next.js 16 (App Router, Turbopack) |
|
||||
| Language | TypeScript |
|
||||
| Styling | Tailwind CSS v4 |
|
||||
| Map | MapLibre GL JS |
|
||||
| WebGL | Deck.gl 9 (IconLayer, PathLayer, MapboxOverlay) |
|
||||
| Animation | Motion (Framer Motion) |
|
||||
| Data | OpenSky Network API |
|
||||
|
||||
## Getting Started
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
cp .env.example .env.local
|
||||
# Optionally add OpenSky credentials — see .env.example
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000).
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
src/
|
||||
├── app/
|
||||
│ ├── globals.css Tailwind config, theme vars
|
||||
│ ├── layout.tsx Root layout (Inter font)
|
||||
│ ├── page.tsx Entry — renders <FlightTracker />
|
||||
│ └── api/flights/route.ts OpenSky proxy with rate limiting + auth
|
||||
├── components/
|
||||
│ ├── flight-tracker.tsx Orchestrator — state, camera, layers, UI
|
||||
│ ├── map/
|
||||
│ │ ├── map.tsx MapLibre GL wrapper with React context
|
||||
│ │ └── flight-layers.tsx Deck.gl overlay — icons, trails, shadows, animation
|
||||
│ └── ui/
|
||||
│ ├── altitude-legend.tsx
|
||||
│ ├── control-panel.tsx Tabbed dialog — search, map style, settings
|
||||
│ ├── flight-card.tsx Hover card with flight details
|
||||
│ ├── scroll-area.tsx Custom scrollbar
|
||||
│ └── status-bar.tsx Live status indicator
|
||||
├── hooks/
|
||||
│ ├── use-flights.ts Polling hook for OpenSky API
|
||||
│ ├── use-settings.tsx Settings context with localStorage persistence
|
||||
│ └── use-trail-history.ts Trail accumulation + Catmull-Rom smoothing
|
||||
└── lib/
|
||||
├── cities.ts Curated aviation hub presets
|
||||
├── flight-utils.ts Altitude→color, unit conversions
|
||||
├── map-styles.ts Map style definitions
|
||||
├── opensky.ts OpenSky API client + types
|
||||
└── utils.ts cn() utility
|
||||
```
|
||||
|
||||
## Design
|
||||
|
||||
- **Dark-first**: CARTO Dark Matter base map, theme-aware UI
|
||||
- **3D depth**: 55° pitch, altitude-based z-displacement via Deck.gl
|
||||
- **Smooth animation**: Catmull-Rom spline trails, per-frame interpolation between polls
|
||||
- **Glassmorphism**: `backdrop-blur-2xl`, `bg-black/60`, `border-white/[0.08]`
|
||||
- **Spring physics**: All UI transitions use spring easing
|
||||
- **Persistence**: Settings + map style in localStorage, `?city=IATA` URL deep links
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Required | Description |
|
||||
| ----------------------- | -------- | ------------------------------ |
|
||||
| `OPENSKY_CLIENT_ID` | No | OAuth2 client ID (recommended) |
|
||||
| `OPENSKY_CLIENT_SECRET` | No | OAuth2 client secret |
|
||||
| `OPENSKY_USERNAME` | No | Basic auth username (legacy) |
|
||||
| `OPENSKY_PASSWORD` | No | Basic auth password (legacy) |
|
||||
|
||||
Without credentials, anonymous access is used (~10 requests/minute).
|
||||
|
||||
## License
|
||||
|
||||
AGPL-3.0
|
||||
Reference in New Issue
Block a user