FrancisLangit / bookly

A book-tracking web-application where users can save and log books. Built on HTML5, CSS, and vanilla JavaScript, with a utilization of the Web Storage API's localStorage mechanism.

Home Page:https://francislangit.github.io/bookly/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README.md Banner

bookly is a book tracking web-application built on HTML5, CSS, and vanilla JavaScript. It was created in partial completion of The Odin Project's Full Stack JavaScript path curriculum.

Installation

A live deployment of bookly is available on GitHub pages.

For those that would like to run the application and/or edit its source code on their local computer, follow the steps below:

  1. Clone the repository with git clone https://github.com/FrancisLangit/bookly or download it as a .zip file and extract it.
  2. Navigate to where the repository is saved on your local machine and open up its index.html file on your preferred web browser.

Usage

To add a book to your library, click on the "Add Book" button in order to open up a modal. Fill up the form within such, inputting data related to the book that you'd like to track. After clicking save, you should then see the book appear in your library, of which you can mark as read or unread, or later on delete.

Bookly saves user data using the Web Storage API's localStorage mechanism. Should you decide to close the application, you should be met with the books you've saved in your library upon opening the website at a later date. Such data is locally saved and is private to whichever computer it belongs to, not being accessible on any other local machine.

GIF demonstrating usage of application

Contributing

Feel free to submit an issue should a bug be found using the application. One is also welcome to make a pull request should they seek to make a major change or introduce a new feature.

License

MIT License

About

A book-tracking web-application where users can save and log books. Built on HTML5, CSS, and vanilla JavaScript, with a utilization of the Web Storage API's localStorage mechanism.

https://francislangit.github.io/bookly/

License:MIT License


Languages

Language:JavaScript 69.4%Language:HTML 24.0%Language:SCSS 3.9%Language:CSS 2.8%