Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 3.26 KB

README.md

File metadata and controls

76 lines (51 loc) · 3.26 KB

Thinkful Local Library Project

Contents

  1. About
  2. Overview
  3. Screenshots
  4. Installation

About this project

This project showcases a dashboard for a local neighborhood library. For the purposes of keeping track of books and trends in borrowing, the dashboard shows:

  • which books are available,
  • which are currently out,
  • and other general statistics about books and library account owners.

Overview

The Local Library dashboard has three main components:

  1. General statistics such as the:

    • total books owned by the library,
    • " books currently borrowed,
    • " accounts registered with the library,
    • and the top 5 books by Genre, Book, and Author.

    These statistics are are produced in /public/src/home.js

  2. The returned status of a book, as well as details about the book such as:

    • the book author,
    • it's genre,
    • and list of the ten most recent borrowers, with their returned status.

    These details are produced in /public/src/books.js.

  3. Finally, a listing of accounts subscribed to the library and per account details. Notably:

    • the name of the account owner,
    • a company name,
    • their email address,
    • when the account was created,
    • the amount of time the account owner borrowed a book,
    • and the current book checked out by the account owner.

    These details are produced in /public/src/accounts.js.

Screenshots

Overall Stats

Overall Statistics Page

Book Information

Book Information Page

Account Information

Account Information Page

Installation

Requirements

Installing the library dashboard requires the following to be done:

  1. cloning this repository locally.
  2. installing nvm (posix | windows).
  3. using nvm to install node.

The install

Step 1: once the requirements are met, navigate to the cloned repository folder and run the following, which should pull all necessary node_modules needed to run the webserver and run the code / display pages:

npm install

Step 2: if the node modules install completes without error, you can start the webserver like this:

npm start

This will launch a forground process in your shell wich you can kill with ctrl-c, or other means.