Skip to content

About

β”‚ πŸ“„ Free, open-source document scanner for Android β€” capture, auto-detect edges, crop, apply filters, OCR text extraction, and export as PDF/JPEG. Built with Kotlin, CameraX, OpenCV, and ML Kit.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

Free Scanner

A free, open-source document scanner app for Android. Capture documents with your camera, auto-detect edges, crop manually, apply filters, extract text with OCR, and export as PDF or JPEG.

Screenshots

Home Camera Crop Editor Export
Home Camera Crop Editor Export

Features

πŸ“· Smart Capture

  • High-quality camera capture using CameraX
  • File-based image saving with EXIF rotation handling
  • Import images from gallery
  • Flash toggle support

πŸ”² Edge Detection & Crop

  • Automatic document edge detection using OpenCV
  • Interactive crop overlay with draggable corner handles
  • Manual corner adjustment for precise cropping
  • Perspective correction to flatten documents

🎨 Image Filters

  • Original β€” no processing
  • Grayscale β€” black & white tones
  • B&W β€” high contrast adaptive threshold
  • Enhanced β€” CLAHE contrast enhancement

πŸ“ OCR (Text Extraction)

  • Powered by Google ML Kit Text Recognition
  • Extract text from scanned documents
  • Copy extracted text directly

πŸ“„ Export & Share

  • Export as PDF or JPEG
  • Rename documents before saving
  • Share directly to WhatsApp, email, or any app
  • Multi-page PDF support

🏠 Document Management

  • Home screen with saved documents list
  • View, share, or delete saved PDFs
  • Sorted by most recent

Tech Stack

Component Technology
Language Kotlin
Camera CameraX
Edge Detection OpenCV 4.9
OCR Google ML Kit
PDF Generation iText 7 (Android)
UI Material Design 3
Min SDK 24 (Android 7.0)
Target SDK 34 (Android 14)

Architecture

app/
β”œβ”€β”€ ui/
β”‚   β”œβ”€β”€ home/          # Home screen - document list
β”‚   β”œβ”€β”€ camera/        # Camera capture
β”‚   β”œβ”€β”€ editor/        # Crop overlay + filters + OCR
β”‚   β”œβ”€β”€ gallery/       # Legacy gallery view
β”‚   └── pdf/           # PDF preview & sharing
β”œβ”€β”€ utils/
β”‚   β”œβ”€β”€ EdgeDetector   # OpenCV edge detection
β”‚   β”œβ”€β”€ PerspectiveTransform  # Warp correction
β”‚   β”œβ”€β”€ ImageFilters   # Grayscale, B&W, Enhanced
β”‚   β”œβ”€β”€ PdfGenerator   # iText PDF creation
β”‚   └── OcrEngine      # ML Kit text extraction
└── model/
    └── Document       # Data models

Build

Requires Android SDK + JDK 17.

# Build debug APK
./gradlew assembleDebug

# Run tests
./gradlew testDebugUnitTest

# APK location
app/build/outputs/apk/debug/app-debug.apk

CI/CD

GitHub Actions automatically builds and tests on every push. Download the APK from Actions artifacts.

App Flow

  1. Home β†’ View saved documents or tap camera FAB
  2. Camera β†’ Frame document and capture
  3. Crop β†’ Auto-detected edges shown, drag corners to adjust, confirm
  4. Edit β†’ Apply filters, run OCR, add more pages
  5. Export β†’ Name your file, choose PDF/JPEG, share

License

MIT

About

β”‚ πŸ“„ Free, open-source document scanner for Android β€” capture, auto-detect edges, crop, apply filters, OCR text extraction, and export as PDF/JPEG. Built with Kotlin, CameraX, OpenCV, and ML Kit.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages