Skip to content

BobbyESP/Docucraft

Repository files navigation

Docucraft logo

Docucraft

An AI-powered document scanner. Fast, intuitive, private, no watermarks.

Kotlin Jetpack Compose ML Kit License Android Badge

Docucraft main functions banner

Docucraft is a modern, efficient, and user-friendly Android application designed for high-quality document scanning and management. Built with the latest Android technologies, it leverages the power of Google's ML Kit to provide fast and accurate document detection directly on your device.


📢 Help us put the app in the Play Store!

We need your help to graduate from testing! If you’re up for it, please join the beta.

How to help:

  1. Fill out the quick form below (Email is the only required field).
  2. I'll add you to the private testers list.
  3. You get early access to features! 👀

Join Beta


📱 Overview

Docucraft transforms your Android device into a portable scanner. Whether you need to digitize receipts, notes, business cards, or contracts, Docucraft makes it easy to capture, organize, and share your documents as PDFs.

Privacy First: The app prioritizes privacy and performance by processing everything locally on your device.

✨ Key Features

  • 📷 Smart Document Scanning: Utilizes a Google-trained Machine Learning model to automatically detect document edges, correct perspective, and enhance image quality.
  • 🔒 On-Device Processing: No internet connection required for scanning. Your documents are never uploaded to a server unless you explicitly choose to share them.
  • 📂 PDF Management:
    • Organize scans in a clean, searchable list.
    • View metadata (size, pages, date).
    • Edit titles and descriptions.
  • 🔍 Search & Filter: Quickly find documents with built-in search tools.
  • 📤 Share & Export: Export as PDF via email, WhatsApp, or save to device storage.
  • 🎨 Modern UI: Built with Material 3 Expressive and Jetpack Compose.
  • 🌙 Dark Mode: Fully supported for low-light environments.

🛠️ How It Works

Docucraft uses the Google ML Kit Document Scanner API to handle the heavy lifting:

  1. Launch: App opens a camera view optimized for documents.
  2. Detect: ML algorithms detect borders in real-time.
  3. Process: Image is auto-cropped and enhanced (shadow removal, skew correction).
  4. Compile: Scan multiple pages into a single PDF.
  5. Save: Indexed in a local Room database and stored in private storage.

💻 Tech Stack

Docucraft is built using modern Android architecture and libraries:

Category Technology Description
Language Kotlin 100% Kotlin codebase.
UI Toolkit Jetpack Compose Material 3 Design system.
Architecture MVVM and MVI Clean Architecture (Presentation, Domain, Data).
DI Koin Lightweight dependency injection.
Database Room Local data persistence.
Async Coroutines & Flow Asynchronous programming.
ML / Vision Google ML Kit Document Scanner API.
File I/O FileKit Simplified file management.
Navigation Jetpack Navigation Type-safe navigation.

🚀 Setup & Build Instructions

To build and run this project locally, follow these steps:

Prerequisites

  • Android Studio Ladybug (or newer).
  • JDK 17 (or newer).
  • Android Device (Android 7.0+ / API 24+).

Steps

  1. Clone the repository:

    git clone [https://github.com/yourusername/Docucraft.git](https://github.com/BobbyESO/Docucraft.git)
    cd Docucraft
  2. Open in Android Studio:

    • Launch Android Studio -> Select "Open" -> Select cloned directory.
  3. Sync & Run:

    • Let Gradle sync dependencies.
    • Connect your physical device (Recommended due to Camera/ML requirements).
    • ⚠️ You may have to create a Firebase project for Crashlytics
    • Click Run ▶️.

📖 Usage Guide

  1. Scan: Tap the floating + button.
  2. Capture: Auto-capture or manual shutter.
  3. Edit: Crop, rotate, or retake pages.
  4. Save: Tap "Save" to generate the PDF.
  5. Manage: Tap any card to Share, Edit, or Delete.

⚠️ Limitations & Notes

  • Hardware: Requires a functioning back camera.
  • Dependencies: Relies on Google Play Services. Ensure your device/emulator has Play Services installed and updated for ML Kit to function.

📄 License

Distributed under the GPL-3.0 License. See LICENSE for more information.


Built with ❤️ by Bobby

If you like this project, please give it a star! 🌟

About

Android document scanner & manager built with Jetpack Compose, Material 3 Expressive and MVI architecture. Scan, organize, share and export your documents with a simple but modern adaptive UI.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages