How stasolejnik/elektron works
eLektron is an Android school-day companion for ZSE Bydgoszcz. A student chooses a class and groups, then views locally cached timetable, substitutions, announcements, and transit; background synchronization refreshes school data, while settings, notifications, widgets, and lesson-note reminders support daily use. The README documents the product capabilities and data providers. Internal edges are limited to relationships visible in excerpts or the source index; links involving unsampled screens and subsystems are shown as unverified where useful.
Main entry points: TransitViewModel.kt Transit screens · SyncCoordinator.kt Sync coordinator · ElektronActivity.kt App shell · TimetableRepositoryImpl.kt Timetable repository
Components 24
Student experience
- App shell
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/ElektronActivity.kt - Class setup
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/presentation/setup/SetupViewModel.kt - Dashboard
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/presentation/dashboard/DashboardViewModel.kt - Timetable
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/presentation/timetable/TimetableViewModel.kt - Lesson notes
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/presentation/timetable/LessonNotesViewModel.kt
School data
- Substitutions
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/presentation/substitutions/SubstitutionsViewModel.kt - Announcements
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/presentation/announcements/AnnouncementsViewModel.kt - School sources
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/remote/sources - Timetable repository
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/repository/TimetableRepositoryImpl.kt
Transit
- Transit screens
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/presentation/transit/TransitViewModel.kt - Journey search
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/repository/TransitJourneyRepository.kt - Live transit
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/repository/TransitLiveRepository.kt
Sync and storage
- Sync coordinator
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/domain/sync/SyncCoordinator.kt - Sync worker
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/work/SyncWorker.kt - Local database
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/local/AppDatabase.kt - Settings
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/repository/SettingsRepositoryImpl.kt
Notifications and extras
- Widgets and tile
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/widget - Notifications
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/work/LocalNotificationSink.kt - FCM push
app/src/gms/kotlin/pl/zse/bydgoszcz/elektron/work/ElektronFirebaseMessagingService.kt - In-app updates
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/update/UpdateRepositoryImpl.kt
Other components
- Student
- BUSearch
- OpenStreetMap
- GitHub releases
Connections 23
- Student → App shell: opens
- App shell → Class setup: offers setup
- Student → Dashboard: views
- Student → Timetable: views
- Student → Substitutions: views
- Student → Announcements: reads
- Student → Transit screens: checks trips
- Student → Lesson notes: adds notes
- Timetable repository → School sources: fetches timetable
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/repository/TimetableRepositoryImpl.kt - Timetable repository → Local database: reads and writes
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/repository/TimetableRepositoryImpl.kt - Sync worker → Sync coordinator: runs sync
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/work/SyncWorker.kt - Sync coordinator → Timetable repository: coordinates sync
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/domain/sync/SyncCoordinator.kt - Sync coordinator → Notifications: emits alerts
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/domain/sync/SyncCoordinator.kt - FCM push → Sync coordinator: requests sync
app/src/gms/kotlin/pl/zse/bydgoszcz/elektron/work/ElektronFirebaseMessagingService.kt - FCM push → Notifications: uses sink
app/src/gms/kotlin/pl/zse/bydgoszcz/elektron/work/ElektronFirebaseMessagingService.kt - Transit screens → Journey search: searches journeys
- Transit screens → Live transit: shows live data
- Journey search → BUSearch: gets journeys
- Live transit → BUSearch: gets live vehicles
- Transit screens → OpenStreetMap: shows map
- Student → Widgets and tile: uses shortcuts
- App shell → Settings: reads preferences
- In-app updates → GitHub releases: checks releases
app/src/main/kotlin/pl/zse/bydgoszcz/elektron/data/update/UpdateRepositoryImpl.kt