phantomknight287/aero

public

checkpoint5b44ca05 months ago275 lines · 7.4 KB

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