Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mwismann/leaderboard

[leaderboard] is a basic website that displays scores submitted by different players thanks to the data provided by the Leaderboard API service. Users can interact by refreshing the scores and submitting their own scores.
https://github.com/mwismann/leaderboard

Last synced: 13 days ago
JSON representation

[leaderboard] is a basic website that displays scores submitted by different players thanks to the data provided by the Leaderboard API service. Users can interact by refreshing the scores and submitting their own scores.

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)

# 📖 [to-do-list]

**[leaderboard]** is a project where I set up a new repo based on my webpack-boilerplate. After that I proceeded to set up the workflows. Then added markup content for the html template to be used with Html Webpack Plugin. From there on, I applied some basic styling to match a wireframe given to us for this project.

## 🛠 Built With

### Tech Stack

Client


  • HTML

  • CSS

  • JavaScript

Server


  • No server at the moment

Database


  • No database was used in this project.

### Key Features

- **[Correct set up of webpack.]**
- **[Correct set up of Linters and GitFlow environment.]**
- **[Basic page structure]**

(back to top)

## 🚀 Live Demo

- [Leaderboard](https://mwismann.github.io/leaderboard/dist/)

(back to top)

## 💻 Getting Started

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

### Prerequisites

- You don't need any previous installation in order to run this project

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/mwismann/leaderboard.git
```

### Install

To install this project dependencies run the following command:

```sh
npm install
```

### Usage

- There's no command required to run the project

### Run tests

- There's no test for this project

### Deployment

- This is not a deployable project

(back to top)

## 👥 Authors

👤 **Mathias Wismann**

- GitHub: [@mwismann](https://github.com/mwismann)
- Twitter: [@mathias_wismann](https://twitter.com/mathias_wismann)
- LinkedIn: [Mathias Wismann](https://www.linkedin.com/in/mathias-wismann/)

(back to top)

## 🔭 Future Features

- **[Features allowing user to add a score]**
- **[Dynamic rendering of the leaderboard content]**
- **[Implementation of Microverse Leaderboard API]**

(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

If you like this project it would be a great help if you could star this repo!

(back to top)

## 🙏 Acknowledgments

I would like to thank to Microverse for providing me the opportunity and inspiration for this work.

(back to top)

## 📝 License

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

(back to top)