Premium
Lumo is the privacy-first AI assistant created by Proton, the team behind encrypted email, VPN, password manager, and cloud storage trusted by over 100 million people. Lumo helps you stay productive, curious, and informed — without ever compromising your privacy.
This is the native Android application wrapper for the Lumo web application (lumo.proton.me) with addition features e.g. voice entry.
🏗️ Architecture Overview
The Lumo Android app follows a clean, modular architecture with clear separation of concerns:
BDP MA --> UIM MA --> WVM MA --> PM MA --> MAVM MA --> SRM MA --> NR %% DI Provider variants BDP --> DP_GMS BDP --> DP_NoGMS DP_GMS --> BMW DP_GMS --> WAPI DP_NoGMS --> WAI %% Manager connections WVM --> CWV %% WebView creation chain CWV --> LWC CWV --> LCC CWV --> WAI LWC --> JSI %% JS Bridge variants WAI --> WAPI WAPI --> BM %% ViewModel data flow MAVM --> WAR MAVM --> TR SVM --> SR %% Navigation routes NR --> CS NR --> PS NR --> PLD CS --> CWV CS --> SIS PS --> SVM %% Billing chain (GMS) BMW --> BM BM --> GP %% Speech chain SIS --> SRM SRM --> Android %% WebView to Web CWV --> Web LWC --> Web %% UI components CS --> LS PS --> PPS PS --> SC PS --> FCI %% Theme system Theme --> TR MAVM --> Theme %% Build variant effects V_Services -.-> DP_GMS V_Services -.-> DP_NoGMS V_Debug -.-> CWV %% Styling classDef manager fill:#e1f5fe classDef viewmodel fill:#f3e5f5 classDef data fill:#e8f5e8 classDef webview fill:#fff3e0 classDef billing fill:#fce4ec classDef speech fill:#f1f8e9 classDef navigation fill:#e8eaf6 classDef ui fill:#e3f2fd classDef config fill:#fafafa classDef external fill:#ffebee classDef variant fill:#e0f2f1 classDef app fill:#f3e5f5 class UIM,WVM,PM manager class MAVM,SVM viewmodel class BDP,DP_GMS,DP_NoGMS,TR,WAR,SR data class CWV,LWC,LCC,WAI,WAPI,JSI webview class BMW,BM billing class SRM,SIS speech class NR,CS,PS,PLD navigation class LS,Theme,PPS,SC,FCI ui class Config,Models config class Web,GP,Android external class V_Env,V_Debug,V_Services variant class MA,LA app ">
graph TB subgraph "📱 Lumo Android App" MA["MainActivity 📋 Single Activity + Compose Navigation"] LA["LumoApplication 🚀 App Initialization"] subgraph "🎛️ Manager Layer" UIM["UIManager 🎨 Edge-to-Edge + Insets"] WVM["WebViewManager 🌐 WebView Lifecycle"] PM["PermissionManager 🔐 Runtime Permissions"] end subgraph "🧠 ViewModels & State" MAVM["MainActivityViewModel 📊 UI State + Events 🔄 Network Checks"] SVM["SubscriptionViewModel 💰 Payment State (GMS Only)"] end subgraph "📦 Data Layer" BDP["BaseDependencyProvider 🏗️ Abstract DI"] DP_GMS["DependencyProvider (GMS) 💳 With Billing"] DP_NoGMS["DependencyProvider (NoGMS) 🚫 No Billing"] TR["ThemeRepository 🎨 Theme Persistence"] WAR["WebAppRepository 🌊 Event Flow"] SR["SubscriptionRepository 💎 Subscription Data (GMS)"] end subgraph "🌐 WebView Integration" CWV["createWebView() 📺 WebView Factory"] LWC["LumoWebClient 🔍 Page Lifecycle + JS Injection"] LCC["LumoChromeClient 📁 File Chooser"] WAI["WebAppInterface 🔗 Base JS Bridge"] WAPI["WebAppWithPaymentsInterface 💳 Payment Bridge (GMS)"] JSI["JsInjector 💉 10+ Injection Functions ⌨️ Keyboard + Payments"] end subgraph "💳 Billing System (GMS Only)" BMW["BillingManagerWrapper 🛡️ Graceful Degradation"] BM["BillingManager 🏪 Google Play Billing 🔄 Cache + Auto-Refresh"] end subgraph "🎤 Speech Recognition" SRM["SpeechRecognitionManager 🗣️ Native Speech API 📊 RMS Tracking"] SIS["SpeechInputSheet 🎙️ Voice UI + Waveform"] end subgraph "🧭 Navigation" NR["NavRoutes 🗺️ Type-Safe Routes"] CS["ChatScreen 💬 Main WebView Screen"] PS["PaymentScreen 💳 Payment Dialog (GMS)"] PLD["PurchaseLinkDialog 🔗 Web Payment (NoGMS)"] end subgraph "📱 UI Components" LS["LoadingScreen ⏳ Lottie Animation"] Theme["LumoTheme 🎨 Material 3 + Sync"] PPS["PaymentProcessingScreen ⚙️ Payment States (GMS)"] SC["SubscriptionComponent 💎 Subscription Info (GMS)"] FCI["FeatureComparisonItem 📋 Plan Features"] end subgraph "🛠️ Configuration" Config["LumoConfig ⚙️ Domain Management 🌐 Multi-Env Support"] Models["Models & Data Classes 📋 UiText, LumoTheme, etc."] end subgraph "🏗️ Build Variants" V_Env["Environment: production"] V_Debug["Debugging: standard | noWebViewDebug"] V_Services["Services: gms | noGms"] end end subgraph "🌍 External Services" Web["Lumo Web App 🌐 lumo.proton.me"] GP["Google Play Billing 💳 Payment Processing"] Android["Android System 📱 Speech + Permissions"] end %% Main initialization LA --> BDP MA --> UIM MA --> WVM MA --> PM MA --> MAVM MA --> SRM MA --> NR %% DI Provider variants BDP --> DP_GMS BDP --> DP_NoGMS DP_GMS --> BMW DP_GMS --> WAPI DP_NoGMS --> WAI %% Manager connections WVM --> CWV %% WebView creation chain CWV --> LWC CWV --> LCC CWV --> WAI LWC --> JSI %% JS Bridge variants WAI --> WAPI WAPI --> BM %% ViewModel data flow MAVM --> WAR MAVM --> TR SVM --> SR %% Navigation routes NR --> CS NR --> PS NR --> PLD CS --> CWV CS --> SIS PS --> SVM %% Billing chain (GMS) BMW --> BM BM --> GP %% Speech chain SIS --> SRM SRM --> Android %% WebView to Web CWV --> Web LWC --> Web %% UI components CS --> LS PS --> PPS PS --> SC PS --> FCI %% Theme system Theme --> TR MAVM --> Theme %% Build variant effects V_Services -.-> DP_GMS V_Services -.-> DP_NoGMS V_Debug -.-> CWV %% Styling classDef manager fill:#e1f5fe classDef viewmodel fill:#f3e5f5 classDef data fill:#e8f5e8 classDef webview fill:#fff3e0 classDef billing fill:#fce4ec classDef speech fill:#f1f8e9 classDef navigation fill:#e8eaf6 classDef ui fill:#e3f2fd classDef config fill:#fafafa classDef external fill:#ffebee classDef variant fill:#e0f2f1 classDef app fill:#f3e5f5 class UIM,WVM,PM manager class MAVM,SVM viewmodel class BDP,DP_GMS,DP_NoGMS,TR,WAR,SR data class CWV,LWC,LCC,WAI,WAPI,JSI webview class BMW,BM billing class SRM,SIS speech class NR,CS,PS,PLD navigation class LS,Theme,PPS,SC,FCI ui class Config,Models config class Web,GP,Android external class V_Env,V_Debug,V_Services variant class MA,LA app
Loading
✨ Key Features
🌐 WebView Integration
- Displays the Lumo web application within a native Android
WebViewcomponent - Uses modern
WebViewsettings for optimal compatibility and performance - Includes JavaScript interface (
WebAppInterface) for bidirectional communication between web app and native Android code - Handles file uploads initiated from the web interface using
WebChromeClient.onShowFileChooser
🎤 Speech-to-Text Input
- Custom voice input experience using Material 3 Modal Bottom Sheet
- Native
android.speech.SpeechRecognizerfor voice capture - Real-time audio waveform visualization based on microphone input levels
- Direct text injection into the web application's composer using JavaScript
- Comprehensive permission handling for
RECORD_AUDIO - On-device recognition detection (API 33+) with status display
💳 In-App Payments (Google Play Billing)
- Full Google Play Billing integration (
com.android.billingclient:billing-ktx) BillingManagerclass handling connection, queries, and purchasesPaymentDialogcomposable triggered via JavaScript interface for premium feature purchases- Subscription management and billing state synchronization
🏗️ Build Variants
The app supports multiple build variants across three dimensions to accommodate different use cases:
📱 Environment Variants (env)
production: Production environment (lumo.proton.me)
🛡️ Debugging Variants (debugging)
standard: Full debugging capabilities including WebView debuggingnoWebViewDebug: GrapheneOS-compatible variant with WebView debugging completely disabled
💳 Services Variants (services)
gms: With Google Mobile Services (in-app billing enabled)noGms: Without Google Mobile Services (alternative payment dialog)
🔧 Build Commands
# Standard GMS development build (with WebView debugging) ./gradlew assembleProductionStandardGmsDebug # NoGMS development build (with WebView debugging) ./gradlew assembleProductionStandardNoGmsDebug # GrapheneOS-compatible NoGMS build (no WebView debugging) ./gradlew assembleProductionNoWebViewDebugNoGmsDebug # Production GMS release build ./gradlew assembleProductionStandardGmsRelease # Production NoGMS release build ./gradlew assembleProductionStandardNoGmsRelease
🚀 Setup & Building
Prerequisites
- Android Studio: Latest stable version recommended
- Android SDK: compileSdk 35, minSdk 29
- Java: Version 17
- Kotlin: 2.0.21
Building the Project
- Clone the repository
- Open the project in Android Studio
- Ensure you have the required Android SDK versions installed
- For release builds, configure signing by setting environment variables:
# Option 1: Set environment variables directly export LUMO_KEY_ALIAS="your_key_alias" export LUMO_KEY_PASSWORD="your_key_password" export LUMO_KEYSTORE_PATH="/path/to/your/keystore.jks" export LUMO_STORE_PASSWORD="your_store_password" # Option 2: Use the .env file (recommended) cp .env.example .env # Edit .env with your actual values source .env
- Build using Gradle:
# Debug builds (no signing required) ./gradlew clean assembleProductionStandardDebug # Release builds (requires environment variables above) ./gradlew clean assembleProductionStandardRelease
🔧 Environment Variables for CI/CD
For automated builds and CI/CD pipelines, you can also use these environment variables:
LUMO_KEY_ALIAS: Key alias in the keystore (defaults to "lumo")LUMO_KEY_PASSWORD: Password for the signing keyLUMO_KEYSTORE_PATH: Full path to the keystore fileLUMO_STORE_PASSWORD: Password for the keystore
Note: Never commit these values to version control. Use your CI/CD platform's secret management system.
🔐 Permissions
The app requires the following permissions:
INTERNET: Web content accessACCESS_NETWORK_STATE: Network connectivity checksBILLING: Google Play Billing integrationRECORD_AUDIO: Speech recognition functionalityREAD_MEDIA_IMAGES/READ_MEDIA_AUDIO: File upload supportREAD_EXTERNAL_STORAGE: Legacy file access (API ≤ 32)
📄 License
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.
🤝 Contributing
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Built with ❤️ using Kotlin, Jetpack Compose, and Material Design 3
