Skip to content

limitedeternity/Scanner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scanner

Top-tier OpenCV document scanner with Flutter frontend

Main points

  • There are two parts: frontend (Flutter GUI) and backend (Flask Server).

  • This application works only within one network.

  • Backend does all the image processing and is required to be up and running.

Setup

Backend (on your computer)

  1. Fetch backend from Releases.

  2. Install Python 3.7.

  3. Upgrade pip: pip3 install --user --upgrade pip

  4. Pull libmagic:

  • Windows x64: I’ve got you covered there
  • Debian/Ubuntu: sudo apt-get install libmagic1
  • Mac: brew install libmagic
  1. Install make:
  1. Go to backend folder, open a console there and run make install

Frontend (on your phone)

  1. Fetch app-*-release.apk from Releases (where * is your processor architecture) and install it.

Usage

  1. Start the backend with make run.

  2. Start the frontend. The application will request STORAGE and CAMERA permissions on the first run – grant them. The frontend will connect to the backend in ~3s (if not already).

  3. You'll see a button at the bottom of the screen. Tap it to take a photo with your camera. Alternatively, you can long-press this button and it'll allow you to select a photo from the gallery (an icon on the button will change).

  4. After you've taken a photo, the application will send it to the backend and wait for it to respond with a scanned variant. Result will be shown in a "Preview" window.

  5. You can discard a result by tapping the left button on the top bar (or going back) or save it to the gallery by tapping the right button on the top bar.

Screenshots

Main screen

Screenshot_20200604-135405

Test sample

receipt

Preview

Screenshot_20200604-135400

Meta

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

@limitedeternity