How minhdeepzaizler/werun works
Project type and purpose
• This is a single-module Android mobile application (“WeRun”) written in Kotlin.
• Purpose: track and display running data (location, distance, history), integrate weather info, social features (friends), background music control (Spotify), and push notifications.
File structure
• Root module with Gradle build files; one Android “app” module.
• Inside app/src/main/java/com/example/werun:
– data/ → domain models (User, Friend, RunData), repository interfaces and Firebase-backed implementations (UserRepository, HomeRepository, etc.), and a REST client (WeatherAPIService).
– services/ → background Android Services for location tracking, notification listening, and music control (Spotify and local media).
– di/ → a module that provides Firebase SDK instances via Dependency Injection.
– ui/ → Jetpack Compose UI: screens (auth, home, run, friends, history, profile, landing), ViewModels, navigation graph, reusable components, theme definitions.
– utils/ → helper functions (e.g. mapping raw GPS data).
• app/src/main/res → drawables, layouts (Compose), XML config for data backups and Firebase.
• External libs: Mapbox SDK, Firebase (via google-services.json), Spotify App Remote AAR.
README insights
• Tech stack: Kotlin, Android, Jetpack Compose, Coroutines/Flow, Firebase (Auth + Firestore/RTDB), Mapbox, Spotify App Remote, external Weather API.
• Architectural hints: MVVM pattern (UI→ViewModel→Repository), Repository pattern, DI for external SDKs.
– Presentation Layer (Android Client)
· UI Screens (Compose)
· ViewModels
– Domain/Data Layer
· Repositories
· Models (User, RunData, WeatherData)
– Background Services
· LocationTrackingService (GPS sensor)
· NotificationListener
· MusicMediaManager & SpotifyMusicManager
– Dependency Injection Module (FirebaseModule)
– External Services
· Firebase (Auth, Firestore/RTDB)
· Mapbox API
· Spotify Remote API
· Weather REST API
– Device Resources
· GPS Sensor
· Media Session
– UI → ViewModel (user events)
– ViewModel → Repository (data fetch/save)
– Repository ↔ Firebase / Weather API (network calls)
– LocationTrackingService → Repository (periodic GPS updates)
– NotificationListener → ViewModel / Repository (incoming notifications)
– Music managers ↔ Spotify SDK & local media player
– DI Module provides SDK instances to Repositories and Services
c. Architectural patterns & principles
– MVVM: clear separation of concerns
– Repository pattern: abstracts data sources
– Dependency Injection: decouples SDK instantiation
– Single-Activity / Navigation Graph: Compose navigation via NavGraph.kt
– Background processing: Android Services for long-running tasks
d. Key technologies / frameworks
– Kotlin + Coroutines/Flow
– Jetpack Compose (UI)
– Firebase SDK (Auth, Firestore)
– Mapbox SDK (maps)
– Spotify App Remote (music control)
– REST client for Weather API
– Gradle/Kotlin DSL for build scripts
Depth over breadth
• Every major package or layer—don’t just show “App → Firebase,” but break out Services, Repositories, ViewModels, and the UI.