Bookshelf - Personal Library

A web application that stores the books you have read, are reading or want to read and makes it easy to search through them.
View Demo · Report Bug

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

The project started as inspiration from "The Odin Project", but after implementing the expected features, it was clear that this application could do more than that. The main features that this version includes are:

• Add data about the book

  • Author
  • Title
  • Status (Finished, Reading, Stopped, For Later)
  • Rating
  • Page you stopped on
  • Year of Reading
  • Genre (choose from default options or add your own)
  • Note

• Edit or delete any of the books in your library.

• You can search and filter the library by any of the above mentioned criteria

• The arrangement of books is flexible. They intelligently compile to evenly sized columns depending on the amount of data in each book tile.

The books are saved in the browser's local storage. The whole application was made with Vanilla JavaScript without any frameworks or packages besides Sass.

Mobile version is in development.

(back to top)

Built With

• Vanilla JavaScript
• SCSS

(back to top)

Getting Started

Prerequisites

• Install npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/daduckster/bookshelf.git

2. Install NPM packages

   npm install

(back to top)

Usage

Dive right in by adding your favorite books. You can use the search bar to search for any of the books you have added, or filter them by clicking the status icons on the right hand side. You can always check the current status by looking at the corresponding icon on the book's tile.

Since the book data is saved in your local browser storage, make sure to access the application on the same device without using Incognito Mode.

(back to top)