| 1 | <div align="center"> |
| 2 | |
| 3 | # ✈️ Aero |
| 4 | |
| 5 | **Real-time flight tracking across all your devices** |
| 6 | |
| 7 | [](https://flutter.dev) |
| 8 | [](https://nestjs.com) |
| 9 | [](https://www.typescriptlang.org) |
| 10 | [](https://react.dev) |
| 11 | |
| 12 | _A comprehensive flight tracking platform with mobile apps and Wear OS companion_ |
| 13 | |
| 14 | </div> |
| 15 | |
| 16 | --- |
| 17 | |
| 18 | ## 🎯 What is Aero? |
| 19 | |
| 20 | Aero is a full-stack flight tracking application that brings real-time flight information to your fingertips. Whether you're tracking your own flights, monitoring departures, or exploring aviation data, Aero provides a seamless experience across mobile, web, and wearable devices. |
| 21 | |
| 22 | **Key Highlights:** |
| 23 | |
| 24 | - 🛫 Real-time flight tracking with live updates |
| 25 | - 📊 Comprehensive flight statistics and analytics |
| 26 | - 📱 Native mobile apps with home screen widgets |
| 27 | - ⌚ Wear OS companion for quick flight info |
| 28 | - 🌐 Modern web interface |
| 29 | - 🔐 Secure user authentication and profiles |
| 30 | |
| 31 | --- |
| 32 | |
| 33 | ## Screenshots |
| 34 | |
| 35 |  |
| 36 |  |
| 37 |  |
| 38 |  |
| 39 |  |
| 40 | |
| 41 | ## Shareable Cards |
| 42 |  |
| 43 | |
| 44 | --- |
| 45 | |
| 46 | |
| 47 | ## 🏗️ Architecture |
| 48 | |
| 49 | This monorepo is organized into distinct components, each serving a specific purpose in the Aero ecosystem. |
| 50 | |
| 51 | ### Backend Services |
| 52 | |
| 53 | #### `api/` - Core REST API |
| 54 | |
| 55 | The heart of Aero, built with NestJS and TypeScript. |
| 56 | |
| 57 | ``` |
| 58 | ┌─────────────────────────────────────────┐ |
| 59 | │ NestJS REST API Server │ |
| 60 | ├─────────────────────────────────────────┤ |
| 61 | │ • JWT Authentication │ |
| 62 | │ • Real-time Flight Tracking │ |
| 63 | │ • Flight Search & Booking Management │ |
| 64 | │ • Airport & Airline Data │ |
| 65 | │ • User Profiles & Statistics │ |
| 66 | │ • Redis Caching Layer │ |
| 67 | │ • Prisma ORM + PostgreSQL │ |
| 68 | │ • OpenAPI/Swagger Documentation │ |
| 69 | └─────────────────────────────────────────┘ |
| 70 | ``` |
| 71 | |
| 72 | #### `backend/` - Legacy PocketBase |
| 73 | |
| 74 | > ⚠️ **Note:** This was used for the initial draft and is no longer actively maintained. |
| 75 | |
| 76 | --- |
| 77 | |
| 78 | ### Client Applications |
| 79 | |
| 80 | #### `app/` - Flutter Mobile App |
| 81 | |
| 82 | Cross-platform mobile application for iOS and Android. |
| 83 | |
| 84 | **Features:** |
| 85 | |
| 86 | - Real-time flight tracking with live updates |
| 87 | - Interactive flight path visualization |
| 88 | - Home screen widgets for quick access |
| 89 | - Detailed flight statistics and analytics |
| 90 | - User authentication and profile management |
| 91 | - Dynamic app icon customization |
| 92 | - Offline data caching |
| 93 | |
| 94 | #### `wearos/` - Wear OS Companion(under development) |
| 95 | |
| 96 | Native Android Wear application for smartwatches. |
| 97 | |
| 98 | #### `landing/` - Marketing Website |
| 99 | |
| 100 | Modern, responsive landing page built with React and Vite. |
| 101 | |
| 102 | **Tech:** |
| 103 | |
| 104 | - React 19 with TypeScript |
| 105 | - Tailwind CSS for styling |
| 106 | - Vite for blazing-fast builds |
| 107 | - Responsive design for all devices |
| 108 | |
| 109 | --- |
| 110 | |
| 111 | ### Supporting Tools |
| 112 | |
| 113 | | Tool | Purpose | Tech | |
| 114 | | ---------- | ------------------------------ | ------------------------ | |
| 115 | | `scraper/` | Web scraping for airline data | Playwright + Bun | |
| 116 | | `scripts/` | Data management and migrations | TypeScript + Bun | |
| 117 | | `openapi/` | Auto-generated API client | Dart (from OpenAPI spec) | |
| 118 | |
| 119 | --- |
| 120 | |
| 121 | ## ✨ Features |
| 122 | |
| 123 | ### Flight Tracking |
| 124 | |
| 125 | - **Real-time Updates** - Live flight position and status |
| 126 | - **Flight Search** - Find flights between any airports |
| 127 | - **Path Visualization** - See flight routes on interactive maps |
| 128 | - **Status Monitoring** - Track departures, arrivals, and delays |
| 129 | - **Historical Data** - Access past flight information |
| 130 | |
| 131 | ### Flight Management |
| 132 | |
| 133 | - **Booking System** - Create and manage flight bookings |
| 134 | - **Multi-flight Tracking** - Monitor multiple flights simultaneously |
| 135 | - **Statistics Dashboard** - View comprehensive flight analytics |
| 136 | - **Personal Flight History** - Track your travel patterns |
| 137 | |
| 138 | ### Data & Information |
| 139 | |
| 140 | - **Airport Database** - Comprehensive airport information |
| 141 | - **Airline Directory** - Detailed airline profiles |
| 142 | - **Aircraft Details** - Aircraft specifications and information |
| 143 | - **Route Information** - Flight route data and statistics |
| 144 | |
| 145 | ### User Experience |
| 146 | |
| 147 | - **Authentication** - Secure user accounts with JWT |
| 148 | - **Personal Profiles** - Customizable user profiles |
| 149 | - **Flight Statistics** - Personal flight analytics |
| 150 | - **Custom App Icons** - Dynamic icon customization |
| 151 | - **Home Widgets** - Quick access from your home screen |
| 152 | - **Wear OS Integration** - Flight info on your wrist |
| 153 | |
| 154 | --- |
| 155 | |
| 156 | ## 🚀 Getting Started |
| 157 | |
| 158 | ### Prerequisites |
| 159 | |
| 160 | Make sure you have the following installed: |
| 161 | |
| 162 | - **Node.js** 20+ and **pnpm** 9.15.1+ |
| 163 | - **Flutter SDK** 3.6.0+ |
| 164 | - **PostgreSQL** database |
| 165 | - **Redis** server |
| 166 | - **Bun** (for scripts and scraper) |
| 167 | - **Android Studio** (for Wear OS development) |
| 168 | |
| 169 | ### Quick Start |
| 170 | |
| 171 | #### 1. Backend API |
| 172 | |
| 173 | ```bash |
| 174 | cd api |
| 175 | pnpm install |
| 176 | cp .env.example .env # Configure your environment variables |
| 177 | pnpm run prisma migrate dev |
| 178 | pnpm run start:dev |
| 179 | ``` |
| 180 | |
| 181 | **API Endpoints:** |
| 182 | |
| 183 | - API Server: `http://localhost:3000` |
| 184 | - API Docs: `http://localhost:3000/docs` |
| 185 | - Scalar API Reference: `http://localhost:3000/reference` |
| 186 | |
| 187 | #### 2. Flutter Mobile App |
| 188 | |
| 189 | ```bash |
| 190 | cd app |
| 191 | flutter pub get |
| 192 | flutter run |
| 193 | ``` |
| 194 | |
| 195 | #### 3. Landing Page |
| 196 | |
| 197 | ```bash |
| 198 | cd landing |
| 199 | bun install |
| 200 | bun run dev |
| 201 | ``` |
| 202 | |
| 203 | #### 4. Scraper |
| 204 | |
| 205 | ```bash |
| 206 | cd scraper |
| 207 | bun install |
| 208 | bun run index.ts |
| 209 | ``` |
| 210 | |
| 211 | #### 5. Scripts |
| 212 | |
| 213 | ```bash |
| 214 | cd scripts |
| 215 | bun install |
| 216 | bun run index.ts |
| 217 | ``` |
| 218 | |
| 219 | ## 💻 Development |
| 220 | |
| 221 | ### API Development |
| 222 | |
| 223 | ```bash |
| 224 | cd api |
| 225 | pnpm run start:dev # Development with hot reload |
| 226 | pnpm run lint # Lint code |
| 227 | pnpm run build # Production build |
| 228 | ``` |
| 229 | |
| 230 | ### Flutter Development |
| 231 | |
| 232 | ```bash |
| 233 | cd app |
| 234 | flutter run # Run on device/emulator |
| 235 | flutter build apk # Build Android APK, the native configuration isn't done for anything other than android |
| 236 | ``` |
| 237 | |
| 238 | ### OpenAPI Client Generation |
| 239 | |
| 240 | Regenerate the Dart API client from the OpenAPI schema: |
| 241 | |
| 242 | ```bash |
| 243 | ./generate-openapi-client.sh # Generate client |
| 244 | ``` |
| 245 | |
| 246 | --- |
| 247 | |
| 248 | <div align= |
| 249 | |
| 250 | **Built with ❤️ for aviation enthusiasts** |
| 251 | |
| 252 | </div> |
| 253 | |
| 254 | --- |
| 255 | |
| 256 | Bonus for scrolling so far. Here is the image of my favourite livery. |
| 257 | |
| 258 |  |
| 259 | |
| 260 | Copyright: TommyNGB |
| 261 | |
| 262 | Link: https://www.jetphotos.com/photo/11888246 |