Skip to content

This project was made for fun, part of my javascript framework studies.

License

Notifications You must be signed in to change notification settings

haikal-shah/OCR-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

This project was made for fun, part of my javascript framework studies.

Prerequisite

Node.js https://nodejs.org/

Install Dependencies

Install the required npm packages:

npm install express multer tesseract.js

Running the Server

Start the server:

node server.js

The server will start on http://localhost:3000.

API Endpoints

POST /ocr

  • Endpoint: http://localhost:3000/ocr
  • Form Data:
    • image (file): The image file to be processed.
Example Using curl
curl -X POST http://localhost:3000/ocr -F "image=@/path/to/your/image.png"
Example Response
{
  "text": "Recognized text from the image."
}

Project Structure

ocr-api/
├── controllers/
│   └── ocrController.js
├── uploads/
└── server.js
  • controllers/ocrController.js: Contains the logic for processing images and performing OCR.
  • uploads/: Directory where uploaded images are temporarily stored.
  • server.js: Entry point of the application, sets up the Express server and routes.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments