Project Name

One paragraph statement about the project.

Additional description about the project and its features.

Built With

• Major languages,
• frameworks,
• technologies used

Live Demo

Live Demo Link

Development (Running locally)

• Clone the project

git clone https://github.com/user/js-template.git

• Install Dependencies

yarn install

To run StyleLint by itself, you may run the lint task:

yarn stylelint:check

Or to automatically fix issues found for StyleLint (where possible):

yarn stylelint

To run ESLint by itself, you may run the lint task:

yarn eslint:check

Or to automatically fix issues found for ESLint (where possible):

yarn eslint

You can also check against Prettier:

yarn format:check

and to have it fix (to the best of its ability) any format issues, run:

yarn format

You can also check against HTML Validator (htmlhint):

yarn lint:html

To generate an accessibility report for this webpage, run the below command, it uses axe:

yarn axe

Style Guides

• CSS Style Guide
• HTML Style Guide
• JavaScript Style Guide
• Git Style Guide
• AXE Accessibility Style Guide

👤 Author

• Github: @author
• Twitter: @author
• Linkedin: @author

🤝 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, resources/assets used
• etc

📝 License

MIT licensed.