Skip to content

A web application that allows users to rate books, write reviews, make reading goals, and organize their books into shelves.

Notifications You must be signed in to change notification settings

cis3296f22/705-bookreview-app

Repository files navigation

Book'd & Rate'd

Book'd & Rate'd is a web application where users are provided a platform to track their reading history as well as leave reviews for various books. After creating an account, the user can create a list of books read or plan to read and/or leave reviews on each book.

Project Board

Link to project board

Demo

Link to GitHub Pages site: https://cis3296f22.github.io/705-bookreview-app/

Installation

  1. Install node through this link if it isn't downloaded on device already

  2. Install dependencies under package.json found in front-end folder with npm install

NOTE: Material UI v5 was used on the frontend and only works with React 17.0.2. There will be an error with any version of React 18 and above. Currently, the issue has yet to be resolved by the developers of Material UI. npm install error If the above error appears enter npm config set legacy-peer-deps true and npm i. The error is caused by the incompatibilities of the dependencies.

How to Run

  1. Run the BookReviewApp (the backend)
  2. npm start

Note: The backend needs to be running in order for the frontend to run properly. Frontend runs on port 3000 while backend runs on port 8080.

Accessing the Database

  1. Run the BookReviewApp file

  2. Access the database through localhost:8080/h2-console

  3. Ensure JDBC URL:jdbc:h2~/bookDB Accessing Database image

  4. Enter 123 as the password