Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajdeepc/character-reader
a tiny optical character reader built with js
https://github.com/rajdeepc/character-reader
ejs express fs javascript multer node ocr-recognition storage tesseract-ocr
Last synced: 4 days ago
JSON representation
a tiny optical character reader built with js
- Host: GitHub
- URL: https://github.com/rajdeepc/character-reader
- Owner: Rajdeepc
- Created: 2019-11-03T09:15:23.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T11:52:07.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T17:11:16.358Z (7 months ago)
- Topics: ejs, express, fs, javascript, multer, node, ocr-recognition, storage, tesseract-ocr
- Language: JavaScript
- Homepage:
- Size: 16 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## OCR Reader with Tesseract.JS
This project demonstrates how to read any image and generate the contents of the image such as texts.
### Getting Started
To get you started you can simply clone the repository:
```
git clone https://github.com/Rajdeepc/javascript-ocr-reader.git
```
### Prerequisites
You need git to clone the repository. You can get git from
[http://git-scm.com/](http://git-scm.com/).
A number of node.js tools is necessary to initialize and test the project. You must have node.js and its package manager (npm) installed. You can get them from [http://nodejs.org/](http://nodejs.org/). The tools/modules used in this project are listed in package.json and include express, mongodb and mongoose.
Download express,mongodb and mongoose from the below sites:
- Tesseract [https://github.com/naptha/tesseract.js](https://github.com/naptha/tesseract.js)
- multer [https://github.com/expressjs/multer](https://github.com/expressjs/multer)
### Installing
and install the dependencies
```
npm install
```
### Run in Local
To Run Locally Steps to follow:
* Run Front End
```
npm start
```
### Built With
* [tesseract.js](https://github.com/naptha/tesseract.js)
* [multer](https://github.com/expressjs/multer)
* [ejs](https://github.com/mde/ejs)
* [express](https://github.com/expressjs/express)
## Contributing
### Create a branch
1. `git checkout master` from any folder in your local `https://github.com/Rajdeepc/javascript-ocr-reader.git` repository
1. `git pull origin master` to ensure you have the latest main code
1. `git checkout -b the-name-of-my-branch` (replacing `the-name-of-my-branch` with a suitable name) to create a branch
### Make the change
1. Follow the "Running locally" instructions
1. Save the files and check in the browser
1. Changes to React components in `src` will hot-reload
1. Changes to markdown files in `content` will hot-reload
1. If working with plugins, you may need to remove the `.cache` directory and restart the server
### Push it
1. `git add -A && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fixed header logo`) to stage and commit your changes
1. `git push my-fork-name the-name-of-my-branch`
1. Go to the [javascript-ocr-reader](https://github.com/Rajdeepc/javascript-ocr-reader.git) and you should see recently pushed branches.
1. Follow GitHub's instructions.
1. If possible, include screenshots of visual changes. A Netlify build will also be automatically created once you make your PR so other people can see your change.
If you would like to donate to this project so that i can give dedicated time to scale this below is the link:
### Donate
If you like my work and if my product has helped you in your development please feel free to give a shoutout:
[](https://paypal.me/RajdeepC?locale.x=en_GB)
### Become a Patreon
Made for developers and designers by Rajdeep Chandra. Tip me on [Patreon](https://www.patreon.com/chandraraj).