How nirbhayph/spothole works
Project type and purpose
• This is a full-stack, user-facing Single Page Application (SPA) built with React.js.
• Purpose: Citizen-side web/mobile front end for “Spothole,” an AI-powered pothole detection, reporting, routing and management solution.
• It consumes REST APIs from a Flask + deep-learning backend (pothole.validation, geocoding, report management) and integrates external services like Google Maps and Google OAuth.
File structure
• Top level:
• public/ & build/ – static assets, HTML templates, generated React build
• src/ – React source code
• package.json, package-lock.json – dependency manifests
• src/ subdivisions:
• components/ – reusable UI pieces (alerts, camera, forms, map markers, steppers)
• navigation/ – routing and layout (navbar, dashboard, profile, route screens)
• utility/ – constants (API endpoints, maps keys)
• serviceWorker.js – PWA support
• The existence of build/, public/ and react-scripts indicates a create-react-app based SPA deployed statically via GitHub Pages.
README for additional insights
• 5 major feature modules: Report, My Complaints, Route Navigation, Profile, Sign In.
• External dependencies: React Google Maps, Axios, FilePond, Google OAuth, Material-UI, CNN backend for media validation, Unsplash for backgrounds.