pprathameshmore / quotegarden Goto Github PK

View Code? Open in Web Editor NEW

34.0 1.0 6.0 1.42 MB

A RESTful API for quotes. The database currently includes more than 75000 quotes.

Home Page: https://quote-garden.onrender.com/

JavaScript 98.79% Dockerfile 1.06% Procfile 0.15%

restapi quotesapi quotes quotes-api nodejs expressjs api-rest freeapi quotegarden prathameshmore

quotegarden's Introduction

Quote Garden - Star on GitHub

A REST API for quotes.

I originally built this for Achieve Chrome Extension project and decided to publish for others to use as well. The database currently includes more than 75000 quotes

Install NPM package

npm install @pprathameshmore/[email protected]

Documentation for NPM package

Get a random quote.
Get all quotes
Get all genres.
Get all authors.

API Documentation

Please do upgrade to V3. Older versions stopped supporting

Get a random quote

Returns a single random quote from the server.

Request

https://quote-garden.onrender.com/api/v3/quotes/random

Params

author: string (Optional)
genre: string (Optional)
count: number (Optional)

Response

{
    "statusCode": 200,
    "message": "Random quotes",
    "pagination": {
        "currentPage": 1,
        "nextPage": null,
        "totalPages": 1
    },
    "totalQuotes": 1,
    "data": [
        {
            "_id": "5eb17ab3b69dc744b4e81942",
            "quoteText": "I think the thing we see is that as people are using video games more, they tend to watch passive TV a bit less. And so using the PC for the Internet, playing video games, is starting to cut into the rather unbelievable amount of time people spend watching TV.",
            "quoteAuthor": "Bill Gates",
            "quoteGenre": "time",
            "__v": 0
        }
    ]
}

Get quotes

Returns multiple quotes.

Request

https://quote-garden.onrender.com/api/v3/quotes

Params

author: string (Optional)
genre: string (Optional)
query: string (Optional)
page: number (Optional)
limit: number (Optional)

Response

{
    "statusCode": 200,
    "message": "Quotes",
    "pagination": {
        "currentPage": 1,
        "nextPage": 2,
        "totalPages": 4
    },
    "totalQuotes": 4,
    "data": [
        {
            "_id": "5eb17aaeb69dc744b4e72a4a",
            "quoteText": "The first rule of any technology used in a business is that automation applied to an efficient operation will magnify the efficiency. The second is that automation applied to an inefficient operation will magnify the inefficiency.",
            "quoteAuthor": "Bill Gates",
            "quoteGenre": "business",
            "__v": 0
        }
    ]
}

Get all genres

Returns all genres.

Request

https://quote-garden.onrender.com/api/v3/genres

Response

{
    "statusCode": 200,
    "message": "Genres",
    "pagination": {
        "currentPage": null,
        "nextPage": null,
        "totalPages": null
    },
    "totalQuotes": null,
    "data": ["age", ...]
}

Get all authors

Returns all authors.

Request

https://quote-garden.onrender.com/api/v3/authors

Response

{
    "statusCode": 200,
    "message": "Authors",
    "pagination": {
        "currentPage": null,
        "nextPage": null,
        "totalPages": null
    },
    "totalQuotes": null,
    "data": ["Bill Gates", ...]
}

Support

Pay using UPI : pprathameshmore@upi

Get featured

If you are using my API in your application, get featured here. Make an issue with your application.

frikishaan.xyz by sheikh005
Bink Chrome Extension by AmitGujar
pprathamesh.github.io by Prathamesh More
Twitter Bot by ahzam1
MotivateU by Shankhanil Ghosh
Quote Garden by cbedoy
Spontaneous - Random quotes by Nikola Franičević

Contributing

All feedback and contributions are welcome!

License

The MIT License (MIT)
=====================

Copyright © 2019 Prathamesh More

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the “Software”), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE. ```

quotegarden's People

Contributors

Stargazers

Watchers

Forkers

karabo-r nicokoenig menesamenhotep ekinbulut dwicahyono catalinmiron

quotegarden's Issues

Get featured in README.

Hey there,
I am using your API in my personal portfolio. (below contact form)
Kindly featured a link to my portfolio in your README.

Twitter bot that tweets your quotes!

Super simple python application that tweets quotes from your API!
Thanks for providing this easy to use endpoint.
https://twitter.com/quotegardenbot

Error while running npm command

I came across this repo and quite impressed by the work you did. First of all Kudos for that. When I tried to install npm package, this is what I am seeing. If I am doing anything wrong, please let me know. I also looked into your NPM Registry. However, the npm command mentioned there was npm i quotegarden

I want to introduce a feature in my software to donate quotes to QuoteGarden. How do I go about doing that?

Not working - Page Not found

It was working fine almost 2 weeks ago. But now, it is not working. I tried to visit the page but there is an error :
Application error
An error occurred in the application and your page could not be served. If you are the application owner, check your logs for details. You can do this from the Heroku CLI with the command

I did a webapp using your API!

Take a look at the webapp and catch me up about your feedback

https://eufraniodiogo.github.io/AwesomeQuotes

The api is not working

Currently the api is not working.

Incorrect documentation on github pages

Documentation hosted on github page is incorrect and has following mistakes:

Endpoint is missing for get random quote, get authors and get author APIs.
Display format of response schema is incorrect for get random quote, get genre and get author APIs.

Get all genres avaible!

Hello, I'm doing a web app that it do a request to the api and I would like to get a list of all genres that are available at the api because with it, I can select at the existing genres at the api and be able to reach a select genre!

Thanks, I would like to get a response, and I would like to congrats you, it's a very good work!

Add new features using genre field

Now we have collections of more than 75k documents. Most have a genre, so we can implement a feature of fetching documents based on genre.

I am thinking to create a Fitness Android App that uses your API to get Quotes, which will be a side feature to give some inspiration to getting fit
I am thinking to upload it to Google Play Stores & Other Stores.

Can I have your permission to upload the app to Store & possibly earn money through it?
The LICENSE tells us that we can use your API for commercial purposes.

Also,
What if my app gained some downloads, will it increase the traffic on the server?
Will the traffic increase the cost? Do I need to pay the cost?
Can you explain in detail?

Return the genre field while fetching quotes

When fetching quotes by random: it returns status, quoteText, quoteAuthor

We can enhance the feature by returning the genre of the quote as : status, quoteText, quoteAuthor, quoteGenre

QuoteGarden down?

Keep getting the error message "This service is not ready to serve traffic. If you are the site owner, please check that your service is passing health checks." Hope its fixed soon!

Error

I cant retrieve any quote. Get a message saying the heroku app is down or something like that

Write test cases

Write test cases to test the code.

Get quotes by genre

Get quotes by the filtering based genre.

@pprathameshmore/[email protected] not working

Hi,

`npm install @pprathameshmore/[email protected]
npm ERR! code E404
npm ERR! 404 Not Found - GET https://registry.npmjs.org/@pprathameshmore%2fquotegardennpm - Not found
npm ERR! 404
npm ERR! 404 '@pprathameshmore/[email protected]' is not in the npm registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)
npm ERR! 404
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.

npm ERR! A complete log of this run can be found in:
npm ERR! /home/jeremy/.npm/_logs/2021-03-21T11_31_55_639Z-debug.log`

Used api in my application

Hey, I read on the README file to create an issue if you used the api in an application :)

Quote Generator - https://github.com/karabo-r/quote-generator

MotivateU: a CLI based application that gets you a random quote on demand. Like the quote? Tweet it by the click of a button

Link to the repository:
https://github.com/Shankhanil/MotivateU
Some features are still under development. A new GUI feature is coming soon.
@pprathameshmore

Can't get quotes from an author

I am using the Quote Garden API to build a new desktop app called MotivateU, and I want to introduce this feature where you can get a random quote from an author. I am using the link

https://quote-garden.herokuapp.com/api/v2/authors/:%22Carl%20Sandburg%22

to get all quotes from an author (say Card Sandburg), but it is returning no quotes.
{"statusCode":200,"totalPages":543,"currentPage":1,"quotes":[]}

Can you help @pprathameshmore

Update documentation

Update documentation,

https://quote-garden.herokuapp.com/api/v2/genres

Fix .yml file

Configure Travis-ci build file for NodeJS

pprathameshmore / quotegarden Goto Github PK

quotegarden's Introduction

Quote Garden - Star on GitHub

Install NPM package

Table of Contents

API Documentation

Get a random quote

Request

Params

Response

Get quotes

Request

Params

Response

Get all genres

Request

Response

Get all authors

Request

Response

Support

Get featured

Contributing

License

quotegarden's People

Contributors

Stargazers

Watchers

Forkers

quotegarden's Issues

Recommend Projects

Recommend Topics

Recommend Org