API for Quotes📑 in JSON and rendered SVG form - Use it anywhere on GitHub, Your Website or wherever you like✨
In your GitHub readme
![QUOTES](https://quotier.vercel.app/quote)
In html
<img src="https://quotier.vercel.app/quote" alt="Quotes" />
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 |
By deafult, when a request to the /quote endpoint is sent, it returns an svg with the dark theme. To specify a custom theme, use the theme query param. The following request returns an svg with the blue theme.
https://quotier.vercel.app/quote?theme=blue
- dark (default)
- light
- blue
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/pushkarydv/quotier-readme-quote
- cd into the folder by using the following command -
cd quotier-readme-quote
- Install the dependencies by running the following command -
npm install
- Setting Up development Enviornment create a
.env
file in root folder 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