Skip to content

A book discovery web app to discover books of different genres and added user authentication for adding books πŸ“š to favourite and reading lists. πŸš€

Notifications You must be signed in to change notification settings

Charmingdc/BookQuest

Repository files navigation

BookQuest πŸ“šπŸ€“

Welcome to BookQuest, your personal book tracker and favorites list manager. BookQuest allows users to add books to their favorites collection, customize settings, and switch themes for a personalized experience. Users can sign up, log in, and manage their preferences securely.

Features πŸ“Œ

  • Sign-up and login system: Users can sign up and log in securely to manage their account.

  • Add books to your favorites list: Keep track of the books you love or are interested in.

  • Theme Customization: Switch between light and dark themes to fit your style.

  • User Settings: Customize your preferences, including username and theme.

  • Quick Search: Easily find books using the Open Library API.

  • User-friendly interface: A clean, intuitive design to manage your favorite books.

Tech Stack βš’οΈ

  • Frontend: React, TypeScript

  • Backend: Open Library API (for fetching book data)

  • Authentication: Firebase (for user sign-up, login, and authorization)

  • State Management: React Hooks & Context Api

  • Build Tool: Vite

  • Styling: CSS (custom design)

Installation (For Developers) πŸ‘¨πŸΌβ€πŸ’»

To get started with BookQuest, follow these steps to run the app locally:

  1. Clone the repository:
 git clone https://github.com/Charmingdc/BookQuest.git
  1. Navigate into the project directory:
cd BookQuest
  1. Install the required dependencies:
npm install
  1. Set up Firebase:

Go to Firebase Console and create a new project.

  • Enable Firebase Authentication (email/password, Google, etc.).

  • Set up Firestore (optional for user settings).

  • Add your Firebase config to your app’s environment variables or directly into the firebase.ts file.

  1. Run the app:
npm run dev

Your app should now be running on http://localhost:5173.

Usage (For Developers) πŸ’»

After setting up and running the app locally:

  1. Sign up or log in to create and access your account securely.

  2. Search for books using the Open Library API.

  3. Add books to your favorites list.

  4. Change themes between light and dark modes from the settings.

  5. Update your user settings (username, theme preferences).

Contributing πŸ‘₯

Contributions are always welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository.

  2. Create a new branch (git checkout -b feature-name).

  3. Make your changes and commit them (git commit -m 'Add feature').

  4. Push the branch to your fork (git push origin feature-name).

  5. Open a pull request to the main repository.

License πŸ“‘

This project is licensed under the GNUP License - see the LICENSE file for details.

About

A book discovery web app to discover books of different genres and added user authentication for adding books πŸ“š to favourite and reading lists. πŸš€

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published