Skip to content

samyuii/React-Based-Book-Review-App

Repository files navigation

BookHive - A Book Review App

A simple and responsive book review application built with React and Tailwind CSS. This app allows users to search for books, view details, rate them, and manage a list of read books using local storage.

Features

  • Discover Books: Search for books and view detailed information including the title, authors, publication date, and description.
  • Star Rating System: Rate books with a star rating for personal reviews.
  • Personal Book List: Add books to your personal list and manage them easily.
  • Local Storage Management: Your book list and ratings are stored locally in your browser that you can retrive for future reference.
  • Responsive Design: Fully responsive UI that works on all devices.

Technologies Used

  • React: JavaScript library for building user interfaces.
  • Tailwind CSS: Utility-first CSS framework for styling.
  • Local Storage: For managing user data.

Installation

  1. Clone the repository:
    git clone https://github.com/theSamyak/book-review-app.git
    
  2. Navigate to the project directory:
    cd book-review-app
    
  3. Install dependencies: You can choose to use either yarn or npm for installing dependencies:
    npm install
    
  4. Create a .env file in the root directory and add your Google Books API key:
    REACT_APP_GOOGLE_BOOKS_API_KEY=your_api_key_here
    
  5. Start the development server:
    npm start
    
  6. Open your browser and navigate to http://localhost:3000 to view the app.

Usage

  • Search for Books: Use the search bar to find books by title or author.
  • View Book Details: Click on a book to view its details including the description, authors, and publication date.
  • Rate Books: Click on the stars to rate a book. Your rating will be saved automatically.
  • Add to Book List: Click the "Add to My Book List" button to save a book to your personal list.
  • Manage Book List: Navigate to the "My Book List" page to view and manage your saved books.

Contributing

Contributions are welcome! Here's how you can contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix:
    git checkout -b feature/your-feature-name
    
  3. Make changes and test your changes locally.
  4. If everything's okay, commit your changes:
    git commit -m 'Add some feature'
    
  5. Push to the branch:
    git push origin feature/your-feature-name
    
  6. Open a pull request.

Contact

For questions or suggestions, please open an issue or contact me at [[email protected]].


Thank you for using BookHive!