chinmaychahar/OCR

IMReader tool makes image documents easy to process, read and listen aloud. It uses OCR with text to speech conversion using Tesseract.js and React Speech Kit

Table of Contents

- Overview
- Interface
- Tech Stack
- Setup Guide
- Local Development
- Contribution Guidelines

🚀 Overview

IMReader Tool is a accessibility tool for processing images at ease. It is built using React.js for frontend, Tesseract.js for OCR and Speech Synthesis feature of the Web Speech API to render audio. It is a small step towards making working with images more accessible. The project takes inspiration from recent developments in the area of OCR TTS to develop feasible reading assistants for differently-abled people while working with digital content.

The tool mainly utilizes:

• Tesseract.js which is a library in pure javascript that supports more than 100 languages, automatic text orientation and script detection
• React-Speech-Kit hooks for in-browser Speech Recognition and Speech Synthesis

💻 Interface

📍 Tech Stack

🔨 Setup Guide

To ensure that you are able to install everything properly, it is recommended to have Git, NPM and Node.js installed.

1. Git

   git version 2.13.1 or higher. Download Git if you don't have it already.

   To check your version of git, run:

    git --version

2. Node

   node version 16.15.1 or higher. Download Node if you don't have it already.

   To check your version of node, run:

    node --version

3. NPM

   NPM version 5.6.1 or higher.

   To check your version of npm, run:

    npm --version

⚡ Local Development

To start with setting up the Local Project Environment:

git clone https://github.com/chinmaychahar/OCR.git
cd frontend
npm run dev:install

Open http://localhost:3000 to view it in your browser.

🤝 Contribution Guidelines

Kindly follow the below guidelines if you wish to contribute to the project:

1. Fork this repository and clone it

git clone https://github.com/chinmaychahar/OCR.git

2. Navigate to the project directory

cd frontend

3. Add a reference(remote) to the original repository

git remote add upstream https://github.com/chinmaychahar/OCR.git

4. Check the remotes for this repository

git remote -v

5. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository)

git pull upstream main

6. Create a new branch

git checkout -b <your_branch_name>

7. Perfom desired changes to the code base and track your changes

git add .
git status

8. Commit your changes

git commit -m "Relevant message"

9. Push the committed changes in your feature branch to your remote repo

git push -u origin <your_branch_name>

10. To create a pull request, click on compare and pull requests

11. Add appropriate title and description to your pull request explaining your changes

12. Click on Create Pull Request