Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 4.03 KB

README.md

File metadata and controls

82 lines (53 loc) · 4.03 KB

Reading Room UI

Deployed Site


This is the home of the Reading Room UI, the front-end of a full-stack personal project.

Repository for the project's Java/Spring Boot back-end service can be found here.

Front End

Back End


Demo

reading-room-demo

Abstract

Reading Room is a full-stack web application that allows users to browse and catalogue a virtual library of books. New users can be registered, authenticated, and create custom "shelves"—individual collections of books. Books with corresponding user notes can then be edited or added/removed from each shelf. Within the "browse" section of the app, users can search for new books by title or author name.

The app's target users are modern book-lovers who need an instant, mobile way to search for new books and keep track of their book collections.

All data is served up via a Java/Spring Boot back-end service, which leverages the Open Library API for book and author data.


Project Architecture Diagram

RR High-Level Architecture Diagram


Instructions

To demo the app, visit the deployed site and log in as a demo user to get started:

email: [email protected] password: guitar


Future Sprints

  • Integration Testing (Cypress.io)
  • Aesthetic Enhancements (loading placeholder ("progress") components, various design and UX enhancements)
  • Functional Enhancements (back-end pagination, security enhancements, etc.)

Local Installation Instructions

Note: Running this project locally requires installations of Node and npm.

  1. Clone this repository to your machine.
  2. cd into the top level of the project repository from the command line and install project dependencies by running npm i.
  3. To run the app in development mode, run npm run dev to launch the application's server.
    • Alternatively, to run in production mode, first run npm run build, then npm run start.
  4. Navigate to http://localhost:3000 in your browser to view the live page.
  5. When prompted, log in with demo user credentials to begin using the app: