Skip to content

AstaRem/home-library-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

276 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Your Home Library App - Shelf, v1.0
Group Project

Description

Shelf is a user-friendly React-based single page application.

It serves as a record-keeping system for your personal book collection.

It is a convenient way to store all information about books you own and be able to access it from any device wherever you are.

User story: I have a lot of books at home. I want a digital solution to organize and manage my extensive book collection:

  • What books do I have at home? I want to see a catalog of my books and be able to search it by author, title, genre. When I am at the bookstore and considering buying a new book, I can quickly check my phone to see if I already own it.
  • Which books I have read?
  • What was the book about, my opinion about it, any other notes I want to leave for myself about the book?
  • Do I have it at home, or borrowed it to a friend?

All information about my books in one place!

Installation

There is no installation needed, please visit: Shelf.

Our App is deployed on Netlify.

Usage

On the home page of the app, the list of existing books in the home library is displayed:

Home

You can serch for the book by title, author or ISBN number:

search result

You can see more details about individual book - click on the tree dots in the right bottom corner of the book card, and the modal with book details will be displayed.

If you read the book, you can check "Read" box, give the book your rating (from 1 to 5) and write your notes about the book, your opinion or anything you want to say to yourself about this book. Save results.

Individual book

I the book is marked as read, the active book icon is displayed on the book card (right top corner). By default, book icon is dimmed.

The book rating value you gave is displayed as stars (from 1 to 5).

If you would like to borrow a book to friend, click "On Loan" button on the book card on the Home screen. The modal for this book will open:

On Loan

Here you can choose the date, when you give the book, write the name of the borrower and save.

On Home screen, the "On Loan" button will become inactive grey - that's how you quickly can see the book is not at home.

You also can see the list of the books you have borrowed by clicking "On Loan" navigation link:

On Loan List

When your friend returned the book, click "Returned" button. The book will disappear from this list and in the Home screen "On Loan" button will become active orange again - that's how you visually see the book is at home.

If you would like to add a new book, all you need to do is click "Add New Book" button or click "Add New Book" navigation link:

Add new book

To find book details from database (Google Books API), enter book title, author or ISBN number into the search field and click "Search" button:

Search by ISBN

Click the radio button next to the book (there might be multiple books displayed when searched by author or title) and click "Add" button. Now your new book details are added to your library catalog:

Book added

If the book can't be found in the database, you can add book details manually:

Add manually

Fill in the details for the book, upload book cover image, click save and the book will be added to your book catalog.

Technologies/libraries/tools used

Future development

The app is a front-end product for now, version 1. For app to function fully, the database solution needs to be implemented, also Login feature in order to display user-specific content.

Credits

Collaborators:

License

This project is licensed under the terms of the MIT license.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors