An open API service indexing awesome lists of open source software.

https://github.com/quavo19/leaderboard

A leader board website where users can input their scores to see their possition as compared to other users
https://github.com/quavo19/leaderboard

api css html5 javascript linters webpack

Last synced: about 2 months ago
JSON representation

A leader board website where users can input their scores to see their possition as compared to other users

Awesome Lists containing this project

README

          

# LEADER BOARD

# 📗 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)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [Leaderboard]

This project uses an API for user engagement to create a leaderboard that displays the names and scores of users in descending order, allowing for easy comparison and healthy competition.

## 🛠 Built With

### Tech Stack

Client


  • HTML

  • CSS

  • JavaScript

### Key Features

- **[Gets data from API]**
- **[Uses asynchronous JavaScript]**

(back to top)

## 🚀 Live Demo
![Screenshot (100)](https://user-images.githubusercontent.com/87555548/219957051-e135b284-dbbf-4a64-a22a-e532e9d1c06f.png)

- [live demo](https://quavo19.github.io/Leaderboard/dist)

(back to top)

## 💻 Getting Started

To get a local copy up and running follow these simple example steps.
### Step :
- You can clone your project by running the command below to clone this project to your local machine in the directory of the folder you want it to be cloned
```sh
git clone https://github.com/quavo19/Leaderboard.git
```
- Alternatively, you can download the zip file of your project by clicking on the `Code` button on the right side of your project page and clicking on `Download ZIP`

- Locate the folder where you cloned your project to and open it ;
### Install

Install this project with:

Example command:

```sh
npm install
```
## Prerequisites

you would need the following to be able to successfully Lunch this project
- Git. If you don't have git installed on your machine you can download it from [here ](https://git-scm.com/downloads).
- A browser(Chrome).
- Node. If you don't have node installed, you can download it from [here ](https://nodejs.org/en/download/).

### Usage

To run the project, execute the following command:

```sh
npm start
```
in a few seconds you should see your project live on your browser

(back to top)

## 👥 Author

👤 **Donald Akite**

- GitHub: [@githubhandle](https://github.com/quavo19)
- Twitter: [@twitterhandle](https://twitter.com/DonaldAkite)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/donald-akite-299a31222/)

(back to top)

(back to top)

# 🔭 Future Features

- [ ] **[Add a background image to the home page.]**
- [ ] **[Add animations to buttons]**
- [ ] **[Load scores without refreshing]**

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you liked this project dont forget to leave a start

(back to top)

(back to top)

## ❓ FAQ

> Add at least 2 questions new developers would ask when they decide to use your project.

- **Does it use a database management system ?**

- NO, it gets data from an involvement API

(back to top)

## 📝 License

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

(back to top)