Skip to content

nkilm/hindi-quotes

Repository files navigation

REST API - Hindi Quotes

An API which display random हिन्दी Quotes.

https://hindi-quotes.vercel.app/random

Method

  • GET

URL params

  • /success
  • /love
  • /attitude
  • /positive
  • /motivational

Success response

An array with JSON object

Without parameter

Sample response without url parameter

With parameter

Sample response with url parameter

Error response - JSON Object with Error Object and Status 400(Invalid Request)

Response for error

Development - How to setup locally?

Check if node is installed

node -v

# if this throws error, then install nodejs
# link - https://nodejs.org/en/download/

Steps

  • After cloning the repository, cd to project folder
npm install 
  • After all packages are installed, start the server
npm start

# or
nodemon server.js

Contributing

To-Do

  • Reduce Time delay in fetching a quote from the Database
  • Handle Errors with better response
  • Add more types of quote