How aiyu-ayaan/bit-app works
Project type and purpose
• This is a multi-module Android application (“BIT-App”) targeting BIT Lalpur students.
• It provides ERP access, syllabus browsing, chat, attendance & CGPA management, notifications, theming, and cloud backup.
File structure
• Top-level modules:
• bitapp – the main Android app, UI layer & navigation
• chat – a feature module for in-app chat
• syllabus – a feature module for static syllabus display
• core – shared data layer, dependency-injection modules, use-cases, and utilities
• Gradle wrappers & CI configs (.github/workflows) for building, testing, and releasing.
• Documentation in mk-docs (docs folder).
README for additional insights
• Confirms mobile focus, Kotlin/Java usage, Material 3 theming, Firebase integration (google-services.json), and a JSON REST API.
a. Main components
• Android App Container
– bitapp (UI + navigation + ViewModels)
– chat module (ChatViewModel, UI screens)
– syllabus module (fragments, JSON assets)
• Core Data Layer
– Dependency-Injection Modules (AppModule, RetrofitModule, RoomModule, FirebaseModule)
– UseCases
– Repositories / NetworkBoundResource
– DataSources:
∙ Room Database (Attendance, Chat, Library, Syllabus tables)
∙ Retrofit Services (BitAppApiService, CollegeNoticeApiService)
∙ Firebase Auth & Firestore & RemoteConfig
∙ DataStore (preferences)
• External Services
– ERP REST endpoints
– Firebase Auth / Firestore / Remote Config
– JSON REST API for notices (bit-lalpur-app.github.io)
• Local resources
– JSON files in syllabus/raw & assets (choose_sem.json etc.)
b. Relationships and interactions
• UI Layers (bitapp/chat/syllabus) → ViewModels → Core UseCases → Core Repositories
• Repositories decide between network (Retrofit/Firebase) vs. local (Room/DataStore) via NetworkBoundResource
• Dependency Injection wires RetrofitModule, RoomModule, FirebaseModule into repositories and use-cases
• Data flows back to UI via LiveData / StateFlows
c. Architectural patterns
• Clean-Architecture / MVVM
• Dependency-Injection (probably using Hilt/Koin via AppModule.kt)
• Repository + UseCase separation
• NetworkBoundResource for offline caching
• Feature modules (chat, syllabus) plugged into host
d. Key technologies & libraries
• Kotlin + Android SDK + Material3 + Jetpack Compose
• Room (androidx.room) for local DB
• Retrofit for REST calls
• Firebase (Auth, Firestore, RemoteConfig)
• DataStore for preferences
• Coroutine + Flow for asynchronous flows
• Gradle Kotlin DSL
Detailed capture
• Break core into sub-components:
• RoomDatabase (with DAOs)
• Retrofit services
• Firebase services
• DataStore
• AppModule, FirebaseModule, RoomModule, RetrofitModule
• For bitapp module, emphasize navigation graphs, screen packages, and theme engine.
Putting it all together:
• Nest chat & syllabus modules under “Presentation” and show they depend on core domain.
• Within core, show DI modules at the bottom injecting into repositories, which interact with DataSources.
• External services sit on the far right: ERP API, Firebase, JSON API.