Skip to content

tobecrazy/QRcodeScanner

Repository files navigation

QR Code Scanner

A simple and efficient QR code scanner application built for Android using Kotlin.

Features

  • Scan QR codes and barcodes
  • Decode and display the content of scanned codes
  • Camera integration with autofocus
  • Simple and intuitive user interface
  • Support for multiple code formats

Prerequisites

  • Android Studio (latest version recommended)
  • Android SDK API level 21 or higher
  • Kotlin 1.5+
  • Gradle 7.0+

Setup Instructions

  1. Clone the repository:

    git clone https://github.com/username/QRcodeScanner.git
    cd QRcodeScanner
  2. Open the project in Android Studio:

    • File → Open
    • Select the project directory
    • Wait for Gradle to sync
  3. Connect an Android device or start an emulator

  4. Build and run the application:

    ./gradlew build
    ./gradlew installDebug

Project Structure

QRcodeScanner/
├── app/                    # Main application module
│   ├── src/main/java/      # Kotlin source files
│   ├── src/main/res/       # Resources (layouts, drawables, values)
│   ├── build.gradle.kts    # Module build configuration
│   └── google-services.json # Firebase configuration (if applicable)
├── gradle/                 # Gradle wrapper and configuration
├── build.gradle.kts        # Project build configuration
└── README.md               # This file

Dependencies

This project uses several Android libraries:

  • AndroidX libraries for compatibility
  • CameraX for camera functionality
  • ML Kit Barcode Scanning for QR code processing
  • Material Design components for UI

Check app/build.gradle.kts for the complete list of dependencies.

Permissions

The application requires the following permissions:

  • CAMERA - To access the device's camera for scanning
  • INTERNET - If using online services for code verification (if applicable)

These permissions are declared in the AndroidManifest.xml file.

Usage

  1. Launch the application on your Android device
  2. Point the camera at a QR code or barcode
  3. The app will automatically detect and decode the code
  4. The decoded content will be displayed on screen
  5. You can copy the content or share it with other apps

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Thanks to Google's ML Kit for the barcode scanning capabilities
  • Material Design guidelines for the UI inspiration
  • The Android developer community for continuous support

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •