📗 Table of Contents

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

📖 leaderboard

leaderboard The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.

Tech Stack

Client

• HTML and CSS
• JavaScript

Key Features

• Score Management
• Modules Directory
• Async Functions

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

1. git
2. VS Code or any code editor
3. npm intalled
4. Webpack

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:rubydevi/leaderboard.git
  cd leaderboard

Install

Install this project with:

Weblint

1. Run this code:

 npm install --save-dev hint@7.x

2. Don't forget to copy .hintrc to the root directory of your project.

Stylelint

1. Run this code:

 npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

2. Don't forget to copy .stylelintrc.json to the root directory of your project.

ESLint

1. Run this code:

 npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

2. Don't forget to copy .eslintrc.json to the root directory of your project.

Usage

To run this project in the browser, simply open the index.html file in your preferred browser.

Run tests

To run tests, run the following command:

 npm hint .

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

 npx eslint .

(back to top)

👥 Authors

👤 Chongtham Ruby Devi

• GitHub: @rubydevi
• Twitter: @arieabyss
• LinkedIn: Chongtham Ruby Devi

(back to top)

🔭 Future Features

• Leaderboard API Implementation
• Asynchronous JavaScript Code
• Customize UI

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project please leave a star, I'd really appreciate it.

(back to top)

Acknowledgments

• I'd like to thank Microverse for this wonderful README template.

📝 License

This project is MIT licensed.

(back to top)