Skip to content

Latest commit

Β 

History

History
100 lines (77 loc) Β· 3.46 KB

README.md

File metadata and controls

100 lines (77 loc) Β· 3.46 KB

Quotify Hub

Website GitHub License

πŸ“ Inspire Your Apps with Quotes

Quotify Hub is a free and open-source API that provides a vast collection of inspiring quotes. Whether you're developing an application, looking for daily motivation, or working on a creative project, Quotify Hub has you covered!

πŸš€ Live Website & API

🌍 Live Website: Quotify Hub

πŸ› οΈ API Endpoint: https://quotifyhub.vercel.app/api/random

βœ… Example Response:

{
  "id": 1,
  "quote": "The only limit to our realization of tomorrow is our doubts of today.",
  "author": "Franklin D. Roosevelt",
  "category": "Motivation"
}

πŸ“Œ Features

  • 🌟 Thousands of curated quotes across various categories.
  • πŸ”— RESTful API for easy integration into web or mobile apps.
  • ⚑ Fast and reliable with JSON responses.
  • πŸ“‚ Filter quotes by category or author.
  • πŸ“Š Rate-limited API to prevent abuse.
  • πŸ’‘ Open-source and customizable.

πŸ“‚ Project Structure

β”œβ”€β”€ index.html   # The main frontend of Quotify Hub
β”œβ”€β”€ index.js     # The backend logic and server setup
β”œβ”€β”€ quotes.js    # The quotes data file
β”œβ”€β”€ package.json # Project dependencies
β”œβ”€β”€ vercel.json  # Deployment configuration
└── README.md    # Documentation file

βš™οΈ Installation & Setup

To run this project locally, follow these steps:

1️⃣ Clone the Repository

git clone https://github.com/itz-rj-here/Quotify-Hub.git
cd Quotify-Hub

2️⃣ Install Dependencies

npm install

3️⃣ Run the Server Locally

npm start

By default, the server will run on http://localhost:3000


πŸ“‘ API Endpoints

Endpoint Method Description
/random GET Returns a random quote
/random?category=motivation GET Returns a random quote from a specific category
/random?limit=10 GET Returns multiple random quotes (limit specified)
/quotes GET Returns all available quotes
/quotes?category=motivation GET Fetch quotes from a specific category
/quotes?limit=10 GET Fetch a limited number of quotes
/quotes/id/:id GET Fetch a quote by its ID

πŸ”— Credits & Inspiration

This project was forked and inspired by Quotes-API. The original author of this repository is Ritu Raj Pratap Singh.

πŸ“œ License

This project is licensed under the MIT License, meaning you can freely use, modify, and distribute it. See the LICENSE file for details.

🀝 Contributing

Contributions are welcome! If you’d like to improve this project, feel free to:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit (git commit -m "Added a new feature").
  4. Push your changes (git push origin feature-branch).
  5. Open a Pull Request.

πŸ“¬ Connect

πŸ’» GitHub: Quotify Hub Repo

πŸ“§ Contact: Open an issue in the GitHub repo for support.

πŸ’– If you like this project, don't forget to ⭐ the repository!

Happy coding! πŸš€