Gh-Reza/Leaderboard

Using this project, you can store players name along with their score

Leaderboard

📗 Table of Contents

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

📖 [Leaderboard]

[Leaderboard] is a project you can save your scores

🛠 Built With

• HTML5
• CSS3
• Javascript
• Git version control
• Webpack

Tech Stack

Client

• HTML5
• CSS3
• Javascript

Server

• VS CODE Live Server Extension

Key Features

• [API integration]
• [User interaction: Users can add theire scores]
• [Visual presentaion: Display the user name and score]

In this project best coding practices is use

🚀 Live Demo

For visiting the live demo click here.

💻 Getting Started

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

Prerequisites

In order to run this project you need:

Google Chrome or other browser

  https://www.google.com/chrome/?brand=JJTC&gclid=CjwKCAjw9J2iBhBPEiwAErwpeSDcMFWiIQWj2u5GY6owZ7OaOHw7dYYCHW7uTR4kvYosNJYd4wt4VxoCiywQAvD_BwE&gclsrc=aw.ds

Github Account:

  https://github.com/

Npm installed:

  https://nodejs.org/en/download

Git installed:

  https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Gh-Reza/Leaderboard.git

Install

Install this project with:

In order to install this project run:

  npm install

Usage

To run the project, execute the following command:

  cd Leaderboard
  npm run build
  npm start

Run tests

To run tests, run the following command:

to check for styling errors:

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

to check for JS errors:

  npx eslint .

To test optimization:

  lighthouse [site url]

Deployment

You can deploy this project using:

Your working browser.

👥 Authors

👤 Reza Merzaie

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

🔭 Future Features

• [Mobile app]

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, don't forget to star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse.

(back to top)

📝 License

This project is MIT licensed.

(back to top)