Al-Amin-Khan-Shakil/Favorite-Books-02

Favorite Books is a user-friendly application where users can list their favorite books along with the author's name. They can conveniently remove books from the list once they've finished reading them. This unique project stands out as a Single Page Application (SPA) created solely with vanilla JavaScript, HTML, and CSS.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Favorite Books

Favorite Books is a simple webpage that shows a saved book-list of a user.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript

Key Features

• Data Saved in Local Storage
• Dynamic List Creation
• Object Constractor

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 install node.js

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Al-Amin-Khan-Shakil/Favorite-Books.git

Install

Install this project with:

  Linters 
  https://github.com/microverseinc/linters-config/blob/master/html-css-js/.github/workflows/linters.yml

Usage

To run the project, execute the following command:

  npm init -y
  npm install --save-dev hint@7.x
  npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
  npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

Run tests

To run tests, run the following command:

  npx hint .
  npx stylelint "**/*.{css,scss}"
  npx eslint .

Deployment

You can deploy this project using:

  .github.io/Favorite-Books/

(back to top)

👥 Authors

👤 Al Amin Khan Shakil

• GitHub: Al Amin Khan Shakil
• Twitter: Al Amin Khan Shakil
• LinkedIn: Al Amin Khan Shakil

(back to top)

🔭 Future Features

• Update Layout
• Complete Website

(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 feel free to follow us on Github.

(back to top)

🙏 Acknowledgments

I would like to thank Ayokunnumi Omololu for her contribution to this project.

(back to top)

❓ FAQ (OPTIONAL)

• Can I contribute to this project?

  • Yes, you can. You can fork you modification on this project. If it gets approval then we will merge your changes.

• What knowledge Should I have to create a project like this?

  • You should have basic HTML, CSS, and JavaScript Knowledge.

(back to top)

📝 License

This project is MIT licensed.

(back to top)