Hello Microverse - README

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

Hello Microverse Project is a simple project with one message in html file says "Hello Microverse!", the main purpose of this project is to learn how to add linter to a project.

This project was built with HTML and CSS.

Can be used as an example to show how linter works:

• HTML Linter Check
• CSS Linter Check

(back to top)

See the project on GitHub Pages

• Live Demo Link

(back to top)

Copy linter.yml, .hintrc and .stylelintrc.json files to your project folder in order to apply html and css linter on your project. Make sure to put linter.yml file in the same directory path as in this project, otherwise linter will not work properly.

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

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/mohametalmeari/Hello-Microverse.git

In order to run this project you need to double click on index.html file to open it in your browser

Install this project with:

  cd Hello-Microverse
  npm install
  npm install --save-dev [email protected]
  npm install --save-dev [email protected] [email protected] [email protected] [email protected]

To run linter checks, execute the following commands:

lighthouse

  lhci autorun --upload.target=temporary-public-storage --collect.staticDistDir=.

webhint

  npx hint .

stylelint

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

(back to top)

This project was done by Mohamad.

👤 Mohamad

• GitHub: @mohametalmeari
• Twitter: @MohametAlmeari
• LinkedIn: mohamet-almeari

(back to top)

JavaScript file will be added with linter for Javascript.

• JavaScript File
• JavaScript Linter

(back to top)

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

If you like this project, please give it a star ⭐️.

(back to top)

I would like to thank Microverse team for helping me learning how to use linter in my projects.

(back to top)

• How to add Linter to my Project

  • Follow the steps in this link https://github.com/microverseinc/linters-config

(back to top)

This project is MIT licensed.

(back to top)