Project Name

One paragraph statement about the project.

| Additional description about the project and its features.

Built With

• Languages: N/A
• Frameworks: N/A
• Technologies used: N/A

Live Demo

Live Demo Link

Getting Started

This is an example of how you may give instructions on setting up your project locally. Modify this file to match your project, remove sections that don't apply. For example: delete the testing section if the currect project doesn't require testing.

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

Prerequisites

• npm (node package manager) - to be able to install packages locally.
• A github Account - to be able to use github actions.

Setup

• Open the terminal.
• Run cd \path\to\where\you\want\your\local\copy
• Clone the repo
  1. Run git clone git@github.com:MrRamoun/README.git
  2. Run cd README/

Install

• install Webhint linter

  1. Run npm install --save-dev hint@6.x
  2. Copy .hintrc file to the root directory of your project.

• install Stylelint linter

  1. Run npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
  2. Copy .stylelintrc.json to the root directory of your project.

Usage

Run tests

• run Webhint linter
  • Run npx hint . on the root of your directory of your project.
• run Stylelint linter
  • Run npx stylelint "**/*.{css,scss}" on the root of your directory of your project.

Deployment

Authors

👤 Author1

• GitHub:
• Twitter:
• LinkdIn:

👤 Author2

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc

📝 License

This project is MIT licensed.