8000 GitHub - PolySpade/document_scanner
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

PolySpade/document_scanner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 

Repository files navigation

Document Processing Web App

Project Overview

The Document Processing Web App is a tool designed to upload and process documents with ease. It allows users to upload images, and retrieve both processed images and extracted text files. The app supports functionality such as drag-and-drop uploads, previewing drafts and downloading results.

Group Members

  • Donald Xu
  • Shanette Presas
  • Hanna De Los Santos
  • Ken Cheng
  • Jersey To

Features

  1. Auto Crop and Warp Image
    • Automatically detects the edges of an image, crops it, and applies perspective warping for better alignment.
  2. Auto Extract Text
    • Utilizes Tesseract OCR to extract text from the processed image, enabling easy text retrieval and editing.

Tech Stack

Frontend

  • Framework: React.js
  • CSS: Tailwind CSS
  • HTTP Client: Axios

Backend

  • Framework: Flask (Python)
  • Libraries:   - os for file handling   - send_from_directory for file serving
  • Hosting: Local server on http://localhost:5000

Image Processing and OCR Libraries

  • cv2 for image processing
  • imutils for simplifying image processing tasks
  • pytesseract for integrating with Tesseract OCR to extract text from images
  • numpy for numerical operations

Installation and Setup

Backend Setup

  1. Install Tesseract OCR

  2. Activate the virtual environment:

       .\venv\Scripts\activate    

  1. Run the Flask server:

       python server.py    

   The server will be available at http://localhost:5000.

Frontend Setup

  1. Navigate to the frontend folder.
  2. Install dependencies:        npm install    
  3. Start the React development server:        npm run dev        The app will be available at http://localhost:3000.

API Endpoints

GET Endpoints

<name> name of the document with file extension

  • http://localhost:5000/uploads/<name>: Download processed output files.

  • http://localhost:5000/drafts/<name>: Retrieve draft images.

  • http://localhost:5000/texts/<name>: Retrieve text files.

DELETE Endpoint

  • http://localhost:5000/delete: Clears all session-related files from the backend.

Usage

  1. Launch both the frontend and backend servers.

  2. Navigate to http://localhost:3000.

  3. Upload an image file.

  4. View draft previews and download processed outputs.


Contributing

Members:

  • Donald Xu: Backend development and API implementation.
  • Shanette Presas: Frontend UI/UX design and integration.
  • Hanna De Los Santos: Testing, debugging, and documentation.
  • Ken Cheng: Backend development and API implementation.
  • Jersey To: Frontend UI/UX design and integration.

Future Enhancements

  • Support for additional file formats (e.g., PDFs).
  • Temporary Cloud storage integration.

License

This project is open-source and licensed under the MIT License.


ui_2 ui_1 ui-3

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  
0