LeaderBoard
📗
Table of Contents
-
📖 About the Project -
💻 Getting Started -
👥 Authors -
🔭 Future Features -
🤝 Contributing -
⭐️ Show your support -
🙏 Acknowledgements -
❓ FAQ -
📝 License
📖
LeaderBoard
LeaderBoard is a simple and powerful application built with webpack and the Fetch javascript API.
🛠
Built With
webpack
Tech Stack
Structure
Style
Key Features
- Add score
- View list of scores
- Refresh scores
🚀
Live Demo
Have a look at the live demo of the project.
💻
Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
- npm installed
- node installed
Setup
Clone this repository to your desired folder:
cd my-folder
git clone [email protected]/ZewdieMc/LeaderBoard.git
Install
Install this project with:
cd LeaderBoard
npm install
Usage
To run the project:
npm start
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.
👥
Authors
- GitHub: @ZewdieMc
- Twitter: @HabtieZewdie
- LinkedIn: Zewdie Habtie
🔭
Future Features
- Improve the look and feel of the application.
🤝
Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️
Show your support
If you like this project send your feedback to encourage me to do more.
🙏
Acknowledgments
I would like to thank Microverse for offering me this opportunity to learn, and practice my skills.
❓
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.
📝
License
This project is MIT licensed. (Check the LICENSE file)