QR Code Generator and Scanner

This Android application allows users to generate and scan QR codes. The app is built using Jetpack Compose for UI, Jetpack Navigation for app navigation, ZXing library for QR code generation and scanning, and CameraX for camera functionalities.

Features

• Generate QR codes from text input
• Scan QR codes using the device's camera
• Modern UI built with Jetpack Compose
• Navigation between screens using Jetpack Navigation
• Deep link handling for shared qr coe image from other app

🛠️ Tech Stack

• Language: Kotlin
• UI: Jetpack Compose
• Architecture: [MVI,Clean Architecture]
• Asynchronous: Coroutines + Flow
• Dependency Injection: [Koin]
• Database: Room / DataStore
• Testing: JUnit, Espresso, MockK, Compose UI Test
• Jetpack Compose - For building native UI.
• Jetpack Navigation - For navigation between screens.
• ZXing - For generating and decoding QR codes.
• CameraX - For camera functionalities.
  • Used ImageAnalysis.Analyzer for analyzing the camera frames in real-time to detect QR codes.

---

📂 Project Structure

com.iscoding.qrcode/
│── data/
│ ├── local/ # [TODO: Local DB/DataStore/SharedPref if any]
│ └── repos/ # Data layer implementations
│ ├── MediaRepositoryImpl.kt
│ ├── QrCodeGeneratorImp.kt
│ ├── QrCodeScannerImp.kt
│ └── QrCodeStorageAnalyzerImp.kt
│
├── di/ # Dependency injection modules
│
├── domain/ # Domain layer (business logic contracts)
│ ├── model/ # Domain models
│ └── repos/ # Repository interfaces
│ ├── MediaRepository.kt
│ ├── QrCodeGenerator.kt
│ ├── QrCodeScanner.kt
│ └── QrCodeStorageAnalyzer.kt
│
├── features/ # Feature-based UI modules
│ ├── generate/ # QR code generation feature
│ │ ├── event/
│ │ ├── util/
│ │ ├── widgets/
│ │ │ ├── GenerateQRCodeScreen.kt
│ │ │ ├── GenerateQRCodeState.kt
│ │ │ ├── GenerateQRCodeViewModel.kt
│ │ │ └── MainScreen.kt
│ │
│ ├── mainactivity/ # App entry activity
│
│ ├── scan/ # QR code scanning feature
│ │ ├── camera/ # Live camera scanning
│ │ │ ├── intent/
│ │ │ ├── widgets/
│ │ │ ├── CameraScanScreen.kt
│ │ │ ├── CameraScanUIState.kt
│ │ │ └── CameraScanViewModel.kt
│ │ │
│ │ ├── storage/ # Scan from storage
│ │ │ ├── allimages/ # All storage images
│ │ │ │ ├── intent/
│ │ │ │ ├── widgets/
│ │ │ │ ├── AllStorageImagesScreen.kt
│ │ │ │ ├── AllStorageImagesUIState.kt
│ │ │ │ └── AllStorageImagesViewModel.kt
│ │ │ │
│ │ │ └── details/ # QR details after scanning
│ │ │ ├── intent/
│ │ │ ├── QrDetailsScreen.kt
│ │ │ ├── QrDetailsUIState.kt
│ │ │ └── QrDetailsViewModel.kt
│ │ │
│ │ └── widgets/
│ │ └── AskFromCameraOrStorageScreen.kt
│ │
│ └── util/ # Shared feature utilities
│
├── graph/ # NavGraph
│
├── util/ # App-wide utilities
│
├── MyApp.kt # Application class
│
res/ # Android resources
│ ├── layout/ 
│ ├── drawable/
│ ├── values/
│ └── mipmap/
│
AndroidManifest.xml

⚙️ Setup & Installation

Requirements

• Android Studio Giraffe+
• JDK 17 (check with java -version)
• Gradle 8.14.3
• Android SDK

Clone & Build

git clone https://github.com/Tonistark92/QR-Code-buddy.git
cd QR-Code-buddy

# Assemble the debug APK
./gradlew assembleDebug

# Run unit tests
./gradlew test

# Run instrumented Android tests
./gradlew connectedAndroidTest

# Run all code quality checks (ktlint, detekt, Dokka)
./gradlew codeQuality

# Format all code (spotless)
./gradlew codeFormat

# Generate Dokka documentation
./gradlew dokkaGenerate

# The generated Dokka docs will be in:
# build/dokka/html/index.html



## Screenshots
![qr1](docs/screenshots/img1.png)
![qr2](docs/screenshots/img2.png)
![qr3](docs/screenshots/img3.png)