https://github.com/eimaam/get-quotes-api
The getQuotes API is a Quote Generator powered by Node.js, offering access to an array of quotes spanning diverse themes such as Motivation, Wisdom, Love, and more. It's a freely accessible resource for incorporating inspiring and thought-provoking quotes into your applications or projects.
https://github.com/eimaam/get-quotes-api
quote-generator quotes quotes-api quotes-application quotes-generator quotes-generator-api
Last synced: 7 months ago
JSON representation
The getQuotes API is a Quote Generator powered by Node.js, offering access to an array of quotes spanning diverse themes such as Motivation, Wisdom, Love, and more. It's a freely accessible resource for incorporating inspiring and thought-provoking quotes into your applications or projects.
- Host: GitHub
- URL: https://github.com/eimaam/get-quotes-api
- Owner: eimaam
- Created: 2023-11-23T10:45:30.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-12-30T20:50:25.000Z (almost 2 years ago)
- Last Synced: 2025-02-07T12:46:47.702Z (8 months ago)
- Topics: quote-generator, quotes, quotes-api, quotes-application, quotes-generator, quotes-generator-api
- Language: TypeScript
- Homepage: https://api-get-quotes.vercel.app
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Get Quotes API
**Quotes from various backgrounds - Motivationn, Science, Business, Technology, Life, Love, Wisdom etc.**
## DEPLOYMENT
- API is deployed on Vercel
**API URL:** https://api-get-quotes.vercel.app/api/v1
## Introduction
The getQuotes API is an Open Source service, powered by Node.js, that provides a dynamic collection of quotes across various categories such as Motivation, Science, Wisdom, Love, and more. Utilizing chatGPT to generate the most of the current array of quotes provided in the API. This API seamlessly integrates with your applications or projects, offering a cool and versatile resource.
Each quote comes with essential details, including the author and category, and it includes a convenient filter route for refining results based on parameters like `Author name`, `category`, or `id`.
## Development
- Create `.env` file and add:
```
PORT=3000
```
PS: You can set the port to any port value you wish to run it from.
- Install deps
```
npm install
```
- Start the project locally by running:
```
npm run start
```
It should log to the console - `Server Started on PORT: 3000` or any port value you supplied.
- Now you can test the endpoints locally. E.g - get all quotes via `http://localhost:3000/api/v1/quotes`
## API Documentation
Your API calls should be to this endpoint: `https://api-get-quotes.vercel.app/api/v1`
GET `/quotes` - Get All Quotes
GET `/random` - get a _random_ quote
GET `/id/:id` - get a quote by `id`
GET `/author/authorName` - get quotes by a specfic _Author_
> Example - get quotes by Steve Jobs:
> https://api-get-quotes.vercel.app/api/v1/author/Steve%20Jobs
GET `/category/categoryName` - get quotes based on a specific _Category_ (Check below for available categories)
> Choose from available categories: Motivation, Life, Wisdom, Love, Technology, Creativity, Courage, Nature, Change, Inspiration, Leadership, Happiness, Perseverance, Imagination, Hope, Friendship..
> Example: get all quotes from "Technology" category
> https://api-get-quotes.vercel.app/api/v1/category/technology
## Contribution
Wish to contribute? I'd love it! - Simply fork the Repo and send a Pull Request with your changes and a detailed PR note/description.
To add quotes - simply open the `quotes.json` file and add your quote at the end of the file using same format as the others & afterwards open a PR with the changes - I'd make sure I get it Live ASAP! Thank you!