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

https://github.com/microverse-fullstack-program/leaderboard

This is leaderboard website. It displays scores submitted by different players. It also allows you to submit your score. All data is preserved using the external Leaderboard API service.. The aim of this project is practice and master Git-flow and async operations with promises and async functions.
https://github.com/microverse-fullstack-program/leaderboard

api-rest css es6 eslint html javascript webpack

Last synced: 24 days ago
JSON representation

This is leaderboard website. It displays scores submitted by different players. It also allows you to submit your score. All data is preserved using the external Leaderboard API service.. The aim of this project is practice and master Git-flow and async operations with promises and async functions.

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)
- [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)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 Leaderboard

> This is leaderboard website. It displays scores submitted by different players. It also allows you to submit your score. All data is preserved using the external [Leaderboard API service.](https://www.notion.so/microverse/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3). The aim of this project is practice and master Gitflow and async operations with promises and async functions.

## 🛠 Built With

### Tech Stack

> - HTML5
> - CSS3
> - JavaScript ES6
> - Webpack

### Key Features

> The key features of this website include.

> - **Interactive**
> - **Responsive**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://microverse-fullstack-program.github.io/Leaderboard/dist/)

(back to top)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need to install npm and node.js as well as webpack and linter modules

### Setup

Clone this repository to your desired folder:
1. Use VScode: open terminal in VScode
2. Navigate to the directory where you want clone the copy of this repository
3. Create new directory [optional]
4. Clone the repo using the below command
> git clone https://github.com/Microverse-Fullstack-Program/Leaderboard

### Usage

This project can be used to practice javascript ES6 and Webpack

(back to top)

## 👥 Authors

> The collaborators of this project.

👤 **Chere Lemma**

- GitHub: [@githubhandle](https://github.com/cherelemma)
- Twitter: [@twitterhandle](https://twitter.com/Chere21271613)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/chere-lemma27211613/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Microverse-Fullstack-Program/Leaderboard/issues).

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

> I would like to thank [Microverseinc](https://github.com/microverseinc) for.

* [Readme-template](https://github.com/microverseinc/readme-template)
* [Linter for HTML and CSS ](https://github.com/microverseinc/linters-config)

(back to top)

## 📝 License

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

(back to top)