Leaderboard

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 10 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h3><b>Leaderboard</b></h3>

</div>

# 📗 Table of Contents

- [📖 About the Project](#about-project)
  - [🛠 Built With](#built-with)
    - [Tech Stack](#tech-stack)
    - [Key Features](#key-features)
  - [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
  - [Setup](#setup)
  - [Prerequisites](#prerequisites)
  - [Install](#install)
  - [Usage](#usage)
  - [Run tests](#run-tests)
  - [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 [Leaderboard] <a name="about-project"></a>

**[Leaderboard]** is a project you can save your scores

## 🛠 Built With <a name="built-with"></a>

- HTML5
- CSS3
- Javascript
- Git version control
- Webpack

### Tech Stack <a name="tech-stack"></a>

<details>
  <summary>Client</summary>
  <ul>
    <li><a href="https://www.microverse.org/">HTML5</a></li>
    <li><a href="https://www.microverse.org/">CSS3</a></li>
    <li><a href="https://www.microverse.org/">Javascript</a></li>
  </ul>
</details>

<details>
  <summary>Server</summary>
  <ul>
    <li><a href="https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer">VS CODE Live Server Extension</a></li>
  </ul>
</details>

### Key Features <a name="key-features"></a>

- **[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 <a href="https://gh-reza.github.io/Leaderboard/dist/" name="live-demo">here</a>.

## 💻 Getting Started <a name="getting-started"></a>

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

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

Github Account:
```sh
  https://github.com/
```
Npm installed: 
```sh
  https://nodejs.org/en/download
```

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

### Setup

Clone this repository to your desired folder:

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

### Install

Install this project with:

In order to install this project run:

```sh
  npm install
```

### Usage

To run the project, execute the following command:

```sh
  cd Leaderboard
  npm run build
  npm start
```

### Run tests

To run tests, run the following command:

to check for styling errors:

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

to check for JS errors:

```sh
  npx eslint .
```

To test optimization:
```sh
  lighthouse [site url]
```

### Deployment

You can deploy this project using:

Your working browser.

## 👥 Authors <a name="authors"></a>

👤 **Reza Merzaie**

- GitHub: [@githubhandle](https://github.com/Gh-Reza)
- Twitter: [@twitterhandle](https://twitter.com/RezaMerzaie)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/reza-merzaie-b94368202/)

## 🔭 Future Features <a name="future-features"></a>

- [ ] **[Mobile app]**

## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Gh-Reza/Leaderboard/issues).

Leaderboard

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README