https://github.com/yosefhesham/leaderboard

A leaderboard created using Leaderboard API service, Webpack, and Gitflow. The user can add a new score and refresh to see his ranking in the leaderboard.
https://github.com/yosefhesham/leaderboard

css html javascript js webpack

Last synced: 3 months ago
JSON representation

A leaderboard created using Leaderboard API service, Webpack, and Gitflow. The user can add a new score and refresh to see his ranking in the leaderboard.

• Host: GitHub
• URL: https://github.com/yosefhesham/leaderboard
• Owner: yosefHesham
• License: mit
• Created: 2022-05-17T14:33:28.000Z (about 4 years ago)
• Default Branch: dev
• Last Pushed: 2023-02-28T14:49:29.000Z (over 3 years ago)
• Last Synced: 2025-03-23T11:11:55.773Z (over 1 year ago)
• Topics: css, html, javascript, js, webpack
• Language: JavaScript
• Homepage: https://yosefhesham.github.io/leaderboard/dist/
• Size: 451 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# 📗 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](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 [Leaderboard] 

**[Leaderboard]** is a A leaderboard created using Leaderboard API service, webpack, and gitflow. The user can add a new score and refresh to see his ranking in the leaderboard.

![image](leaderboard.png)

## 🛠 Built With 

### Tech Stack 

  Client

  


    
Javascript

    
HTML5

    
CSS3

    
Leaderboard API Service

     
Webpack

  


### Key Features 

- **[Show top ranked users]**

- **[Add Users]**

- **[Refresh the board]**

(back to top)


## 🚀 Live Demo 

You can check a **Live Demo** [here.](https://yosefhesham.github.io/leaderboard/dist/)

(back to top)


## 💻 Getting Started 

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

### Prerequisites

- A web browser (like Google Chrome, Opera...).

- A code editor (like Atom, VScode...).

### Setup

To setup the project locally: clone the repository using:

```

git clone https://github.com/yosefHesham/leaderboard

```

### Install dependencies

run : `npm install`

### Build the app

run: `npm run build`

### Run the app

run: `npm start`

### Deployment

Use github pages or just run index.html to test it locally.

(back to top)


## 👥 Authors 

👤 **Yosef Hesham**

- GitHub: [@yosefHesham](https://github.com/yosefHesham)

- LinkedIn: [Yousef Hesham](https://www.linkedin.com/in/yousef-hesham98/)

- Twitter: [@yosef](https://twitter.com/Yousef45653478)

(back to top)


## 🔭 Future Features 

- [ ] **[Delete a user]**

- [ ] **[Reset a score]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

Give a star if you like this project!

(back to top)


## 🙏 Acknowledgments 

- Hat tip to Microverse's code reviewers and to everyone who reviewed my project and made suggestions.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)