Git Product home page Git Product logo

readme-quote-api's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.