Skip to content

yatish-jain/readme-quote-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QUOTIER

quotes

API for Quotes📑 in JSON and rendered SVG form - Use it anywhere on GitHub, Your Website or wherever you like✨

How to use

In your GitHub readme

![QUOTES](https://readme-quote-api.vercel.app/quote)

In html

<img src="https://readme-quote-api.vercel.app/quote" alt="Quotes" />

Endpoints

Base URL - https://readme-quote-api.vercel.app/

EndPoint Returns
/ Hello Page in API
/quote A random quote in rendered SVG form
/quote?type=json Quote in json format
/all All quotes in JSON format within a single response

Contribution Guidelines

Append your quote to quote.json inside the quote/ folder and raise the PR.

{
    "quote":"Your new Quote",
    "author":"Author of your quote",
}

Run the application locally

  • Make sure you have NodeJS installed. Check it by typing this command in your terminal -
node --version
  • Fork this repository.
  • Clone this repository by running the following command in your terminal -
git clone https://github.com/GDSC-RTU/readme-quote-api
  • cd into the folder by using the following command -
cd readme-quote-api
  • Install the dependencies by running the following command -
npm install
  • Setting Up development Enviornment create a .env file in root folver and add the following line
NODE_ENV = development
  • To run the application, type the following command in your terminal -
npm run dev
  • Access the results produced by accessing the following URL in your browser -
localhost:3000

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%