README.md

Module 2: Awesome Books E6

📗 Table of Contents

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

📖 Awesome Books ES6

Awesome Books ES6 is a simple web app that stores books, it uses modular architechture.

🛠 Built With

HTML, CSS, NodeJS

Tech Stack

Structure

• HTML

Style

• CSS

Linters

• Webhint
• Stylelint
• ESLint

Key Features

• Refactoring JS architecture.
  • Use Modules.

(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/Awesome_Books_ES6.git

Install

Install this project with:

  cd Awesome_Books_ES6
  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 .

👥 Authors

👤 Author1

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

🔭 Future Features

• Rebuild the website using React.

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

-Why use modular programming ?

• Modular programming usually makes your code easier to read because it means separating it into functions that each only deal with one aspect of the overall functionality.

(back to top)

📝 License

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

(back to top)