Awesome Books

📗 Table of Contents

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

Awsome books

Awesome Books is a website built with basic UI and vanilla JavaScript.

Built With

• HTML, CSS, JavaScript
• VSCode

(back to top)

Tech Stack

Client

• JavaScript

• Html

• CSS

Server

• N/A

Database

• LocalStorage

Key Features

• Awesome Books stores all data in Local Storage so the user never loose the book list

(back to top)

Live Demo

Live Demo Link

Getting Started

Clone this repository to get started with the project, make sure to configure linters by following the instructions in the Linters README file

(back to top)

Prerequisites

In order to run this project you need:

• A working computer.
• Connection to internet.

Setup

• Clone the folder to your local machine.
• Open the index.html file in your brower.

(back to top)

Run tests

• After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.
• For stylelint errors run:sudo npx stylelint "*/.{css,scss}" --fix for automatic fix.

(back to top)

Install

You don't need to install anything.

Usage

To run the project, execute the following command:

• Go to the file called index.html.
• Right click Open Live Server.

(back to top)

Authors

👤 Ashmal Zahra

• GitHub: @ashmalzahra
• Twitter: @AshmalZahraa
• LinkedIn: ashmal-zahra

(back to top)

🔭 Future Features

• Refactor the JavaScript code using classes to make it more modular.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the information provided to build this project.

(back to top)

❓ FAQ (OPTIONAL)

• Can I use the project for any purpose?

  • Yes, you can.

• Is the information saved in any database?

  • No, all data is saved in Local Storage.

(back to top)

📝 License

This project is MIT licensed.

(back to top)