How lucasomac/shesafe works
Project Type and Purpose
• SheSafe is a Kotlin Multiplatform mobile application.
• Targets: Android (Jetpack Compose + MVVM) and iOS (SwiftUI).
• Purpose: Personal safety toolkit (emergency contacts, location sharing, fake call, alerts) with Firebase backend and Google Sign-In.
File Structure
• Modules:
– androidApp/ : Android front end, structured by Clean Architecture (presentation, domain, data, framework).
– iosApp/ : iOS front end (SwiftUI).
– shared/ : Kotlin Multiplatform shared code (common business logic, routes, resources).
• Layers in androidApp:
– presentation/ (ViewModels, UI Composables)
– domain/ (Entities, Repositories interfaces, UseCases)
– data/ (Models, RepositoryImpl)
– framework/ (DataSourceImpl, Services for Firebase, DI)
• Configuration & build scripts: Gradle, Kotlin DSL.
README
• Mentions tech stack: Kotlin, Compose, Multiplatform, Firebase, Google Sign-In, Material3.
• Highlights Clean Architecture and key features.
Main Components
A. Mobile Frontends
1. Android App
– Jetpack Compose UI
– ViewModels (MVVM)
2. iOS App
– SwiftUI Views
– Calls shared use-cases directly
B. Shared KMP Module
– Business logic, route definitions, enums
C. Domain Layer (Android-specific, mirrored in shared if applicable)
– UseCases
– Repository interfaces
– Entities
D. Data Layer
– RepositoryImpl (adapts DataSources to Domain)
– Models (HelpRequestModel, SecureContactModel, etc.)
E. Framework Layer
– DataSources Impl (FirebaseDataSourceImpl)
– Services (AuthFirebaseService, HelpRequestFirebaseService…)
– DI container (SheSafeDependenciesInjection)
F. External Services
– Firebase (Auth, Firestore, Realtime DB)
– Google Sign-In
G. Platform SDKs
– Android SDK
– iOS SDK
Relationships & Interactions
• UI → ViewModel → UseCase → Repository interface → DataSource → Firebase Service → Firebase backend.
• Shared KMP code is invoked by both Android and iOS layers for common logic.
• Google Sign-In via FirebaseAuth.
• DI module wires up RepositoryImpl to UseCases and DataSources.
Architectural Patterns & Design Principles
• Clean Architecture: Separation into presentation / domain / data / framework.
• MVVM on Android; SwiftUI + shared use-cases on iOS.
• Dependency Injection (SheSafeDependenciesInjection).
• Kotlin Multiplatform for code reuse.
• Asynchronous calls via Coroutines.
Essential Elements
• Clear component names.
• Arrowheads indicating call direction (UI → ViewModel → UseCase → …).