@@ -7,13 +7,39 @@ description: Enterprise-Grade Smart City Platform for Air Quality Monitoring & U
77
88<div align = " center" >
99
10- <a href = " https://nextjs.org/" ><img src = " https://img.shields.io/badge/Next.js-16.0-black?logo=next.js&logoColor=white" alt = " Next.js" /></a >
11- <a href = " https://www.typescriptlang.org/" ><img src = " https://img.shields.io/badge/TypeScript-5.0-3178C6?logo=typescript&logoColor=white" alt = " TypeScript" /></a >
12- <a href = " https://tailwindcss.com/" ><img src = " https://img.shields.io/badge/Tailwind-3.4-38bdf8?logo=tailwind-css&logoColor=white" alt = " Tailwind CSS" /></a >
13- <a href = " https://react.dev/" ><img src = " https://img.shields.io/badge/React-19-61DAFB?logo=react&logoColor=black" alt = " React" /></a >
14- <a href = " https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.08.01_60/gs_CIM009v010801p.pdf" ><img src = " https://img.shields.io/badge/NGSI--LD-Compliant-00A3E0" alt = " NGSI-LD" /></a >
15- <a href = " LICENSE" ><img src = " https://img.shields.io/badge/License-MIT-green.svg" alt = " License" /></a >
16- <a href = " http://makeapullrequest.com" ><img src = " https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt = " PRs Welcome" /></a >
10+ <a href = " https://nextjs.org/" >
11+ <img
12+ src = " https://img.shields.io/badge/Next.js-16.0-black?logo=next.js&logoColor=white"
13+ alt = " Next.js"
14+ />
15+ </a > <a href = " https://www.typescriptlang.org/" >
16+ <img
17+ src = " https://img.shields.io/badge/TypeScript-5.0-3178C6?logo=typescript&logoColor=white"
18+ alt = " TypeScript"
19+ />
20+ </a > <a href = " https://tailwindcss.com/" >
21+ <img
22+ src = " https://img.shields.io/badge/Tailwind-3.4-38bdf8?logo=tailwind-css&logoColor=white"
23+ alt = " Tailwind CSS"
24+ />
25+ </a > <a href = " https://react.dev/" >
26+ <img
27+ src = " https://img.shields.io/badge/React-19-61DAFB?logo=react&logoColor=black"
28+ alt = " React"
29+ />
30+ </a > <a href = " https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.08.01_60/gs_CIM009v010801p.pdf" >
31+ <img
32+ src = " https://img.shields.io/badge/NGSI--LD-Compliant-00A3E0"
33+ alt = " NGSI-LD"
34+ />
35+ </a > <a href = " LICENSE" >
36+ <img src = " https://img.shields.io/badge/License-MIT-green.svg" alt = " License" />
37+ </a > <a href = " http://makeapullrequest.com" >
38+ <img
39+ src = " https://img.shields.io/badge/PRs-welcome-brightgreen.svg"
40+ alt = " PRs Welcome"
41+ />
42+ </a >
1743
1844** Enterprise-Grade Smart City Platform for Air Quality Monitoring & Urban Infrastructure Management**
1945
@@ -29,47 +55,66 @@ description: Enterprise-Grade Smart City Platform for Air Quality Monitoring & U
2955
3056### Key Capabilities
3157
32- <img src = " https://img.shields.io/badge/Feature-Air%20Quality%20Monitoring-blue" alt = " Air Quality" />
58+ <img
59+ src = " https://img.shields.io/badge/Feature-Air%20Quality%20Monitoring-blue"
60+ alt = " Air Quality"
61+ />
3362** Air Quality Monitoring** - Real-time AQI data from OpenAQ with interactive visualizations
3463
35- <img src = " https://img.shields.io/badge/Feature-Smart%20City%20Integration-green" alt = " Smart City" />
64+ <img
65+ src = " https://img.shields.io/badge/Feature-Smart%20City%20Integration-green"
66+ alt = " Smart City"
67+ />
3668** Smart City Integration** - NGSI-LD compliant data from Orion Context Broker
3769
38- <img src = " https://img.shields.io/badge/Feature-Advanced%20Mapping-orange" alt = " Mapping" />
70+ <img
71+ src = " https://img.shields.io/badge/Feature-Advanced%20Mapping-orange"
72+ alt = " Mapping"
73+ />
3974** Advanced Mapping** - Road networks, streetlights, and POI visualization with clustering
4075
41- <img src = " https://img.shields.io/badge/Feature-Analytics%20Dashboard-purple" alt = " Analytics" />
76+ <img
77+ src = " https://img.shields.io/badge/Feature-Analytics%20Dashboard-purple"
78+ alt = " Analytics"
79+ />
4280** Analytics Dashboard** - Comprehensive admin panel for data management
4381
4482<img src = " https://img.shields.io/badge/Feature-Open%20APIs-red" alt = " APIs" />
4583** Open APIs** - RESTful endpoints with authentication and rate limiting
4684
47- <img src = " https://img.shields.io/badge/Feature-Responsive%20Design-yellow" alt = " Responsive" />
85+ <img
86+ src = " https://img.shields.io/badge/Feature-Responsive%20Design-yellow"
87+ alt = " Responsive"
88+ />
4889** Responsive Design** - Mobile-first approach with modern UI/UX
4990
5091---
5192
5293## Features
5394
5495### Air Quality Monitoring
96+
5597- ** Real-time Data** - Live AQI measurements from 10,000+ global stations
5698- ** Interactive Maps** - MapLibre GL with clustering and heatmaps
5799- ** Location Details** - Historical charts, health recommendations, data export
58100- ** Advanced Search** - Filter by location, parameters, and time range
59101
60102### Smart City Infrastructure
103+
61104- ** Road Networks** - Real-time road segment data visualization
62105- ** Streetlights** - Infrastructure monitoring and management
63106- ** Weather Integration** - Live weather data correlated with air quality
64107- ** Citizen Reports** - Community-driven issue reporting system
65108
66109### Developer Tools
110+
67111- ** API Keys Management** - Generate, revoke, and monitor API usage
68112- ** Comprehensive Documentation** - Interactive examples in 4 languages
69113- ** OpenAPI Specification** - Auto-generated API docs
70114- ** Testing Tools** - Built-in endpoint testing utilities
71115
72116### Admin Dashboard
117+
73118- ** Report Management** - Track and resolve citizen-submitted issues
74119- ** Analytics** - Real-time statistics and trends
75120- ** User Management** - Role-based access control
@@ -143,23 +188,27 @@ NEXT_PUBLIC_API_BASE_URL=http://localhost:3000
143188### Tech Stack
144189
145190** Frontend**
191+
146192- Next.js 16 (App Router)
147193- React 19
148194- TypeScript 5
149195- Tailwind CSS 3.4
150196- Framer Motion
151197
152198** Data Visualization**
199+
153200- MapLibre GL (maps)
154201- Chart.js (charts)
155202- Supercluster (clustering)
156203
157204** Smart City Integration**
205+
158206- NGSI-LD (ETSI standard)
159207- Orion Context Broker
160208- Smart Data Models
161209
162210** APIs**
211+
163212- OpenAQ (air quality)
164213- Custom RESTful endpoints
165214- API key authentication
@@ -173,18 +222,21 @@ For detailed architecture, see [ARCHITECTURE.md](https://github.com/minhe51805/U
173222Comprehensive documentation is available in the ` /urbanreflex-fe/docs ` folder:
174223
175224### Core Documentation
225+
176226- ** [ System Architecture] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/ARCHITECTURE.md ) ** - Technical architecture and data flows
177227- ** [ API Endpoints] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/API-Endpoints.md ) ** - Complete API reference
178228- ** [ Admin Dashboard] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/ADMIN-DASHBOARD.md ) ** - Admin panel usage guide
179229- ** [ NGSI-LD Integration] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/NGSI-LD-Integration.md ) ** - Smart city data integration
180230
181231### Developer Guides
232+
182233- ** [ Code Examples] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/Code-Examples.md ) ** - Copy-paste ready examples
183234- ** [ Testing Guide] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/Testing-Guide.md ) ** - Testing strategies and tools
184235- ** [ Security Best Practices] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/Security-Best-Practices.md ) ** - Security guidelines
185236- ** [ Deployment Guide] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/Deployment-Guide.md ) ** - Production deployment steps
186237
187238### Quick References
239+
188240- ** [ Documentation Index] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/INDEX.md ) ** - Complete docs table of contents
189241- ** [ API Endpoints] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/API_ENDPOINTS.md ) ** - Quick API reference
190242- ** [ Migration Guide] ( https://github.com/minhe51805/UrbanReflex/blob/main/urbanreflex-fe/docs/MIGRATION_GUIDE.md ) ** - Version migration instructions
0 commit comments