How pduy99/heliostranslator works
Project Overview & Main Components
• Key layers and modules:
• Shared Module: Contains the common business logic and supports Clean Architecture layers such as core (data, network, database, domain, and presentation), feature-specific modules (conversation, history, scan, text translation, etc.), and SQLDelight configuration.
• Android Module (androidApp): Provides native Android implementation – it includes dependency injection (with Hilt), navigation (NavHost and type-safe navigation), core components, and composables implementing the UI.
• iOS Module (iosApp): Holds iOS-specific setup, layout resources, and SwiftUI integration.
• CI/CD: The .circleci directory shows that CircleCI is used for continuous integration.
• External services and libraries such as MLKit (for image translation OCR), DeepL (for advanced translation using HTTP network calls via Ktor), SQLDelight (for local database persistence), and shared logging/Kermit.
Relationships and Interactions
• From the UI components (Android Composables or SwiftUI screens) to ViewModels.
• From ViewModels to Use Cases in the Domain layer.
• From Use Cases to Repositories in the Data layer.
• From Repositories to external data sources (network APIs, local database via SQLDelight, etc.).
Architectural Patterns & Design Principles
• Data, Domain, and Presentation layers in the shared code.
• Platform-specific concerns (native UI, dependency injection, navigation) isolated in androidApp and iosApp.
• Multiplatform-first approach, where the shared module is the core and both client apps reuse its business logic.
Technology & Frameworks
• Kotlin Multiplatform, Jetpack Compose (Android), SwiftUI (iOS)
• Ktor (HTTP networking), SQLDelight (database), MLKit (image translation), CameraX (camera functionality)
• Hilt for dependency injection (Android), and Kermit for logging.