Awesome Books Project

# 📗 Table of Contents

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

📖 Awesome Books Project

Awesome Books Project is the project of module 2.It is a simple website and it can be used for saving books. Here we used HTML, CSS to design site and used Javascript for dynamic functionality.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• DOM
• JavaScript Object
• FlexBox
• Linters

Key Features

• Using JavaScript Object
• Local Storage
• Dynamics of HTML using JavaScript
• DOM Manipulation
• ES6

(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:

• A web browser to view output e.g Google Chrome.
• An IDE e.g Visual studio code.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

    "git clone https://github.com/mahdinoori2000/awesome-book.git"

• Navigate to the location of the folder in your machine:

    cd ./user/

Install

Install all dependencies:

    "npm install"

Usage

To run the project, follow these instructions:

• You have to clone this repo to your local machine.
• If you want to run it on your preferred browser, run:

     "Open index.html or about.html in the project directory with your preferred browser"

Run tests

To run tests, run the following command:

• HTML linter errors run:

npx hint .

• CSS linter errors run:

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

• JavaScript linter errors run:

npx eslint .

• For unit testing, run:

npm test

Deployment

You can deploy this project using: GitHub Pages,

• I used GitHub Pages to deploy my website.
• For more information about publishing sources, see "About GitHub pages".

(back to top)

👤 Author

• GitHub: @zuhebahmed88091
• Twitter: @zuhebahmed88091
• LinkedIn: Zuheb Ahmed

(back to top)

🔭 Future Features

• Add Backend
• Add CSS styles
• About Section

(back to top)

🤝 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 and how I managed to build it!

(back to top)

🙏 Acknowledgments

• We want to thank microverse for providing the design and requirements for this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)