A modern Android app for fiber internet technicians to quickly send professional WiFi welcome messages to new customers.
- Quick Message Generation — Fill in customer details and instantly generate a welcome message
- Multiple Send Options — SMS, Share sheet, or Copy to clipboard
- QR Code Generation — Generate WiFi QR codes customers can scan to connect
- Cyberpunk Theme — Beautiful dark/light mode with neon accents
- Custom Templates — Create and manage multiple message templates
- Import/Export — Backup and share templates between devices
- Privacy-Focused — Customer data is stored on-device; after 10 minutes of inactivity, only the active intake form and its entered data are cleared. Crash reporting can be enabled or disabled in Settings
- Input Validation — Real-time validation with helpful error messages
- Android 8.0 (API 26) or higher
- ~10 MB storage
- Go to Releases
- Download the latest
QWelcome-v<version>.apk - Enable "Install from unknown sources" if prompted
- Install and enjoy!
# Clone the repo
git clone https://github.com/H2OKing89/QWelcome.git
cd QWelcome
# Make gradlew executable (Unix/Mac only)
chmod +x gradlew
# Build debug APK
# Unix/Mac:
./gradlew assembleDebug
# Windows:
gradlew.bat assembleDebug
# APK will be at: app/build/outputs/apk/debug/app-debug.apkThe repository includes a non-production Firebase configuration for debug builds. A local release build requires your own app/google-services.json in addition to release signing.
The CI release workflow (.github/workflows/release.yml) does not read a checked-in app/google-services.json; it generates one at build time and signs the APK from repository secrets. The following secrets must be configured under repo Settings → Secrets and variables → Actions:
| Secret | Purpose |
|---|---|
GOOGLE_SERVICES_JSON_BASE64 |
Base64-encoded google-services.json for the release Firebase project, decoded to app/google-services.json before the build. |
KEYSTORE_BASE64 |
Base64-encoded release signing keystore, decoded to qwelcome-release.keystore. |
KEYSTORE_PASSWORD |
Password for the release keystore. |
KEY_PASSWORD |
Password for the qwelcome signing key inside the keystore. |
- Language: Kotlin 2.4.0
- UI: Jetpack Compose with Material 3
- Architecture: MVVM with StateFlow
- Storage: Proto DataStore
- Navigation: Navigation Compose
- QR Generation: QRose library
- Crash reporting: Firebase Crashlytics (optional)
- Updates: GitHub Releases in-app updater
- Min SDK: 26 (Android 8.0)
- Target SDK: 36
app/src/main/java/com/kingpaging/qwelcome/
├── data/ # Data models, repository, DataStore
├── di/ # Dependency injection (CompositionLocal providers)
├── navigation/ # Navigator abstraction for intents
├── ui/ # Compose screens and components
│ ├── components/ # Reusable UI components
│ ├── theme/ # Colors, typography, theming
│ ├── settings/ # Settings screen
│ ├── templates/ # Template management
│ ├── export/ # Export functionality
│ └── import_pkg/ # Import functionality
├── util/ # Utility classes (QR, phone formatting, etc.)
└── viewmodel/ # ViewModels for each screen
- Android Studio (latest stable recommended)
- JDK 17 or newer (required by Gradle and CI; app Java and Kotlin bytecode targets remain 11)
- Android SDK 36
The Gradle tasks below are tested with JDK 17.
# Debug build
./gradlew assembleDebug
# Release build (requires signing config)
./gradlew assembleRelease
# Run unit tests (JVM)
./gradlew test
# Run connected Android instrumented tests (on a device or emulator)
./gradlew connectedAndroidTest
# Run Android Lint (all variants)
./gradlew lintgradle/gradle-daemon-jvm.propertiesis generated byupdateDaemonJvmand is intentionally ignored in git.- Regenerate locally when needed with:
./gradlew updateDaemonJvmThis project follows standard Kotlin coding conventions. The codebase uses:
- MVVM architecture
- Unidirectional data flow with StateFlow
- Compose for all UI
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- QRose for QR code generation
- Orbitron Font for the cyberpunk display font
- Jetpack Compose team for the amazing UI toolkit