README.md

COWIN Certificate Verify API

A NodeJS based project to host web api for verifying and get details of COWIN certificate.

Requirements

1. NodeJS (14+ recommended)
2. yarn package manager

API Endpoints

1. Get certificate data by uploading certificate image(jpeg/png)

Request

POST /verify-certificate
Content-Type: multipart/form-data

file: <Image-Binary-data>

Response

200 OK
Content-Type: application/json

{
  "data": {
    "shortInfo": {
      "userRefId": "",
      "name": "",
      "gender": "",
      "age": "",
      "nationality": "",
      "vaccineDosesGiven": "",
      "vaccineTotalDosesNeeded": "",
    },
    "certificateData": {}
  }
}

Setup project

1. Run yarn command to install dependencies
2. Run yarn dev command to start app for development purpose
3. Run yarn dev:debug command to start in debug mode for development purpose
4. run yarn build to build the project. Build project located in dist folder.
5. run yarn start to start server

Deploy app using PM2

First build the app then run the app

1. Run npm run build to build app to dist folder
2. Run pm2 start pm2-ecosystem.config.js to start app
3. Run pm2 stop pm2-ecosystem.config.js to stop
4. Run pm2 restart pm2-ecosystem.config.js to restart
5. Run pm2 reload pm2-ecosystem.config.js to reload
6. Run pm2 delete pm2-ecosystem.config.js to delete