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

https://github.com/nkaleth/leaderboard

This is a JavaScript project for a Leaderboard list app, using webpack and ES6 features, notably modules.
https://github.com/nkaleth/leaderboard

apis es6-javascript gitflow-workflow html-css-javascript webpack

Last synced: about 2 months ago
JSON representation

This is a JavaScript project for a Leaderboard list app, using webpack and ES6 features, notably modules.

Awesome Lists containing this project

README

        



logo


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 LEADERBOARD ](#-Leaderboard-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Leaderboard

> This is a JavaScript project for a Leaderboard list app, using webpack and ES6 features, notably modules.

## 🛠 Built With

### Tech Stack

> This project uses the following stack :

Client

### Key Features

> Here are some key features of the application :

- **Use callbacks and promises.**
- **Learn how to use proper ES6 syntax.**
- **Use ES6 modules to write modular JavaScript.**
- **Use webpack to bundle JavaScript.**

(back to top)

## 🚀 Live Demo

[Leaderboard Project](https://nkaleth.github.io/Leaderboard/)

(back to top)

## 💻 Getting Started

> Clone the repository by clicking on the 'Code' button and copy the link

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

### Prerequisites

In order to run this project you need:

-visual studio
-github

### Setup

Clone this repository to your desired folder:

```sh
mkdir my-folder
cd my-folder
git clone [email protected]:Nkaleth/Leaderboard.git
```

-

### Install

Install this project with:

```
npm install
```
### Usage I

Change the main branch to the right one, execute the following command:

```sh
git checkout final_touches
```

### Usage II

To run the project, execute the following command:

```sh
npm start
```

### Run tests

To run tests, run the following command:

Example command:

To run the webhint linter

```sh
npx hint .
```

To run the stylehint linter

```sh
npx stylehint "**/*.{css,scss}"
```

To run the ESLint linter

```sh
npx eslint .
```

(back to top)

## 👥 Author

👤 **Nilton Segura**

- GitHub: [@Nkaleth](https://github.com/Nkaleth)
- Twitter: [@NoeSeguraL](https://twitter.com/NoeSeguraL)
- LinkedIn: [LinkedIn](https://linkedin.com/in/nseguralu)

(back to top)

## 🔭 Future Features

- **Use API to update the leaderboard**

(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 star it!

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse

(back to top)

## 📝 License

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

(back to top)