OCR APP

PROJECT Documentation

This document provides information about the APIs and deployment for this project.

Table of Contents

• Home
• Add Record
• Record Details
• Edit Record
• Delete Record
• History Page
• Run the Project

Home

GET /

The home route where two buttons appear:

• ADD RECORD: Adds a new record to the database.
• SHOW HISTORY: Shows the history of records.

Add Record

GET /record/add

Renders the addRecord page, allowing users to input an image (less than 2MB, JPG, JPEG, PNG only). After clicking the submit button, a POST /record/add request is made. The server calls the Google Vision API to extract data, saves it to the database, and redirects to /record/:recordId.

POST /record/add

Creates a new record by calling the Google Vision API to extract data from the submitted image and saves it to the database. Redirects to /record/:recordId.

Record Details

GET /record/:recordId

Displays information about a specific record, including its status and extracted information. Provides a button to edit the record.

Edit Record

GET /record/edit/:recordId

Renders a form to edit the given record, allowing users to change the extracted information, or they can Delete the record which calls record/delete/:recordId.

POST /record/edit/:recordId

Updates the information of the specified record based on the submitted form.

Delete Record

GET /record/delete/:recordId

Deletes the record from the database if the recordId exists.

History Page

GET /record/history

Renders the history page containing all past submitted records. Includes filter options to search through records based on status, creation date, date of birth, date of issue, and date of expiry. Users can choose any combination to filter the history of records.

Run the Project

To deploy and run the application:

1. Create a .env file in the root directory with two environmental variables:

   • PORT: Relevant port number
   • MONGO_URL: MongoDB database URL

2. Create an account on Google Cloud Platform.

3. Enable the Google Vision API.

4. Create a service account and get the JSON credential.

5. Rename the credential file as 'credential.json'.

6. In the terminal, run npm install to install the required packages.

7. To start the project, run npm start.