Skip to content

This project is about building a web-app to store your books collection in browser's local storage with CRUD feature.

License

Notifications You must be signed in to change notification settings

M-AminAlizadeh/Awesome-books-collection

Repository files navigation

📗 Table of Contents

📖 Awesome Books Collection

Awesome Books Collection is a web app to store your favorite books. The user can Add/Read/Update/Delete (all CRUD functionalities) to the collection.

This project was built with vanilla JavaScript with modules (functional programming) and a Class (object-oriented programming).

I tried to use both approaches to learn how to implement an idea into a digital solution using both of these principles.

For storing data I chose local storage the reason was to learn how to store data in it and how to manipulate data using vanilla JavaScript.

Desktop screenshots

desktop-list-of-books desktop-add-new-book desktop-contact-me

Mobile screenshots

mobile-hamburger-menu mobile-list-of-books mobile-add-new-book mobile-contact-me

🛠 Built With

Tech Stack

Client

Key Features

  • Fully responsive
  • OOP
  • Functional approach (using modules)
  • Pretty UI and elegant UX as a side project!
  • SPA (single page application)
  • Routing system
  • CRUD
  • Display Date and Time
  • Linters (Eslint, Sytlelint, Webhint, Lighthouse)
  • GitHub Actions
  • Well documented

(back to top)

🚀 Live Demo

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

To run this project you'll need:

Setup

Clone this repository to your desired folder:

  git clone [email protected]:M-AminAlizadeh/Awesome-books-collection.git awesome-books-collection
  cd awesome-books-collection

Install

Install this project with:

  npm install

Usage

To start/run the project:

  npm start

Deployment

You can deploy this project using these:

(back to top)

👥 Authors

Amin Alizadeh

(back to top)

🔭 Future Features

  • Dark/light Theme
  • Add backend and DB instead of local storage

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project kindly give it a ⭐

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the idea behind this and I only tried to implement it.

(back to top)

📝 License

This project is under MIT license.

(back to top)