Module 2: 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
• 📝 License

📖 Awesome Books

Awesome Books is a simple web app that stores books.

🛠 Built With

HTML, CSS, NodeJS

Tech Stack

Structure

• HTML

Style

• CSS

Linters

• Webhint
• Stylelint

Key Features

• Refactoring JS code to use classes.

  • Use JavaScript classes instead of objects and arrays.

• Styled UI.

(back to top)

🚀 Live Demo

• Link to the live project.

(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: Open terminal on the same folder of the project and run:

 npm install

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com/codedit334/Module2-Awsome-Books.git

Install

Install this project with:

  cd Module2-Awsome-Books
  npm install

Usage

To run the project, open index.html

Run tests

To run tests, run the following command:

To check for html errors run:

  npx hint .

To check for css errors run:

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

To check for js errors run:

  npx eslint .

Deployment

Deployed using Github Pages.

(back to top)

👥 Authors

👤 Author1

• GitHub: @codedit334
• Twitter: @oussedit
• LinkedIn: Oussama Elabdioui

👤 Author2

• GitHub: @ZewdieMc
• Twitter: @HabtieZewdie
• LinkedIn: Zewdie Habtie

(back to top)

🔭 Future Features

• Implement Navigation bar.
• Three content sections:
  • Books list.
  • Add book form.
  • Contact info.

(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 send your feedback to encourage me to do more.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for offering me this opportunity to learn, and practice my skills.

(back to top)

❓ FAQ

-Why use linters?

• The use of linters helps to diagnose and fix technical issues, also linters can help teams achieve a more readable and consistent style, through the enforcement of its rules.

(back to top)

📝 License

This project is MIT licensed. (Check the LICENSE file)

(back to top)