Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 3.61 KB

README.md

File metadata and controls

90 lines (56 loc) · 3.61 KB
Raw

X Doc Scanner

X Doc Scanner is a powerful and intuitive document scanning application designed for Android devices using Jetpack Compose. This app enables users to scan, manage, and share documents effortlessly, leveraging cutting-edge technologies to provide a robust and user-friendly experience.

Screenshots

App Screenshot

Features

  • High-Quality Scanning: Capture documents with exceptional clarity using advanced image processing.
  • User-Friendly Interface: Simple and intuitive design powered by Jetpack Compose.
  • Document Management: Rename, remove, and organize your documents effortlessly.
  • In-App PDF Viewing: View scanned documents directly within the app.
  • Easy Sharing: Share your scanned documents via email, messaging apps, or other platforms.
  • Offline Access: Store and access all documents locally on your device.
  • Batch Scanning: Scan multiple pages in one go and save them as a single document.
  • Object cleaning: Remove or erase ant unwanted object from scanned documents using Google's ML Kit.
  • Secure Storage: Keep your documents secure and private.

Installation

  1. Download the latest Doc Scanner APK file from the releases page.
  2. Enable installation from unknown sources in your device settings.
  3. Open the downloaded APK file and follow the on-screen instructions to install.

Usage

  1. Launch the App: Open Doc Scanner from your app drawer.
  2. Scan Documents: Use the camera to capture documents. The app will automatically enhance and crop the scanned images.
  3. Manage Documents: Organize your documents by renaming, removing, and viewing them directly in the app.
  4. Share Documents: Easily share your scanned documents via email, messaging apps, or other platforms.

Technology Used

  • Kotlin: Programming language for Android development.
  • Jetpack Compose: Modern toolkit for building native UIs.
  • Room Database: Provides an abstraction layer over SQLite for seamless database operations.
  • DAO (Data Access Object): Manages data access methods efficiently.
  • Google's ML Kit: Utilized for text recognition and image processing.

Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone https://manish7924/DocScan-MLKit.git

  2. Open the project in Android Studio:

    cd doc-scanner

Open Android Studio and select "Open an existing Android Studio project." Navigate to the doc-scanner directory and open it.

Build and run the project:

Click the "Run" button in Android Studio to build and deploy the app on your connected device or emulator.

Contributing

We welcome contributions from the community! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Commit your changes and push them to your branch.
  4. Create a pull request with a detailed description of your changes.
  5. Please ensure your code adheres to the project's coding standards and includes appropriate tests.

Contact

If you have any questions, suggestions, or feedback, please feel free to reach out:

Developer: Manish Chidar

Email: manishchidar79@gmail.com

License

This project is licensed under the MIT License. See the LICENSE for more details.