QuoteQuest

Welcome to the QuoteQuest App, an interactive web application that allows users to explore and discover a vast collection of inspirational quotes. This app provides a user-friendly interface to browse quotes by authors, categories, and more. Users can also contribute their favorite quotes or suggest updates to existing ones.

Demo

Demo.mp4

API

The Quotes API utilized in this project is available at https://github.com/MehakKambo/quotes-api. You can find more information about the API and its endpoints in the repository.

Table of Contents

1. Introduction
2. Features
3. Getting Started
   • Prerequisites
   • Installation
   • Running the App
4. Usage
5. Components
6. Styling
7. Contributing
8. License

Introduction

The QuoteQuest App is a single-page web application built with React, designed to provide an engaging and enjoyable experience for users interested in exploring and sharing inspirational quotes. Whether you're a fan of a particular author, looking for quotes by category, or simply in need of a random dose of motivation, this app has you covered.

Features

• Explore Authors: Browse quotes by your favorite authors.
• Discover Categories: Explore quotes by categories such as love, motivation, wisdom, and more.
• Get Inspired: Find the perfect quote to uplift and motivate you.
• Contribute Quotes: Share your favorite quotes with the community.
• Update Quotes: Suggest updates or corrections to existing quotes.
• Random Quotes: Get a random quote to brighten your day.
• Quote by ID: Retrieve a specific quote using its unique identifier.

Getting Started

Prerequisites

To run the QuoteQuest App locally or deploy it to a web server, you'll need the following prerequisites:

• Node.js and npm (Node Package Manager)

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/MehakKambo/quotes-generator.git

2. Navigate to the project directory:

   cd quotes-app

3. Install project dependencies:

   npm install

Running the App

After completing the installation steps, you can run the QuoteQuest App locally:

1. Start the development server:

   npm start

2. Open your browser and visit http://localhost:3000 to access the app.

Usage

Once the QuoteQuest App is running, you can explore, search, and interact with the app's various features:

• Home: The landing page with quick access to different app sections.
• Authors: Browse quotes by author name.
• Categories: Explore quotes by categories.
• Random Quote: Get a random quote for daily inspiration.
• Contribute Quote: Share your favorite quotes with the community.
• Update Quote: Suggest updates or corrections to existing quotes.

Components

The QuoteQuest App is composed of several reusable components that are organized for easy maintenance and development. Each component serves a specific purpose and can be customized as needed.

Styling

The app is styled using CSS. You can easily modify the styling to match your design preferences.

Contributing

Contributions to the QuoteQuest App project are welcomed. If you'd like to contribute, please follow these guidelines:

1. Fork the repository and clone it to your local machine.
2. Create a new branch for your feature or bug fix.
3. Make your changes, test thoroughly, and ensure the code follows best practices.
4. Commit your changes and create a pull request.

License

This project is licensed under the BSD-3-Clause License - see the LICENSE file for details.

Thank you for choosing the QuoteQuest App. I hope this README provides all the information you need to get started with the app. If you have any questions or feedback, please don't hesitate to reach out.

Happy coding!