phantomknight287/aero

public

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