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

https://github.com/codehass/leaderboard

The leaderboard project is a simple web application where we can add the names and the scores of players, and use the API to show it.
https://github.com/codehass/leaderboard

Last synced: about 1 month ago
JSON representation

The leaderboard project is a simple web application where we can add the names and the scores of players, and use the API to show it.

Awesome Lists containing this project

README

          


logo

Microverse README Template

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [📝 License](#license)

# 📖 Leaderboard

> The leaderboard project is a simple web application where we can add the names and the scores of players, and use the API to show it.

## 🛠 Built With

### Tech Stack
- HTML
- CSS
- Javascript(ES6)
- Webpack

(back to top)

## 🚀 Live Demo

> Add a link to your deployed project.

- [Live Demo Link](https://codehass.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.
- A code editor like Visual Studio Code with Git and Node.js
In order to run this project you need:

### Setup
- In the terminal, go to your file directory and run this command. :

```
$ git clone git@github.com:codehass/Leaderboard.git
```
### Install

- Install this project with:

```
$ npm install
```
### Usage

- To run the project, execute the following command:
```
$ npm run build
```
```
$ npm start
```

### Deployment
This app is deployed in the GitHub Pages for easy viewing upon merged on the main branch.
Please find the link in the Live Demo section.

(back to top)

## 👥 Authors

👤 **Author**

- GitHub: [@codehass](https://github.com/codehass)
- Twitter: [@hassanelourdy](https://twitter.com/hassanelourdy)
- LinkedIn: [Hassan El OUARDY](https://www.linkedin.com/in/hassan-el-ouardy-360b99169/)

(back to top)

## 🔭 Future Features

- [ ] **[Use API to send and receive the data]**
- [ ] **[Use Webpack]**

(back to top)

## 📝 License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)