Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ghostesso/leaderboard

A basic leaderboard application has been created using JavaScript. This application showcases scores contributed by various players and provides a means for users to submit their own scores
https://github.com/ghostesso/leaderboard

api async javascript

Last synced: 18 days ago
JSON representation

A basic leaderboard application has been created using JavaScript. This application showcases scores contributed by various players and provides a means for users to submit their own scores

Awesome Lists containing this project

README

        


Leaderboard

# 📗 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)
- [Author](#author)
- [Deployment](#triangular_flag_on_post-deployment)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 Leaderboard list

**Leaderboard** is a simple webpack project build with HTML, CSS and Javascript using techs like linters, and Gitflow.

## 🛠 Built With

### Tech Stack

Client

### Key Features

- **Add a task to complete**
- **Check out if the task has been completed**
- **Remove all completed tasks**

(back to top)

## 🚀 Live Demo

- [Link](https://ghostesso.github.io/Leaderboard/dist/)

## 💻 Getting Started

Obtaining API Keys: Explain which APIs the application consumes and direct users to the respective API documentation or websites where they can register for an API key. Provide clear steps on how to sign up, obtain the key, and ensure they understand any limitations or restrictions.

Securing API Keys: Emphasize the importance of securing API keys to prevent unauthorized access. Provide guidelines on storing these keys securely, such as using environment variables or configuration files outside the version control system.

Integration into the App: Walk users through the process of integrating the obtained API key into the application. This may involve adding the key to a configuration file or using a specific method to access it during runtime.

API Usage: Include examples or code snippets that demonstrate how to make API requests using the keys. This will help users understand the syntax and usage of the APIs in the context of the application.

### Prerequisites

In order to run this project you need:

- Linters
- Webpack configuration

### Setup

Clone this repository to your desired folder:

### Install

Install this project with:

### Usage

To run the project, execute the following command:

### Run tests

To run tests, run the following command:

- npx hint .

### Author

👤 **Author**

- GitHub: [@GhostEsso](https://github.com/GhostEsso)
- Twitter: [@TambanaEssohanam](https://twitter.com/TambanaEssohana)
- LinkedIn: [@TambanaEssohanam](https://www.linkedin.com/in/essohanam-tambana-62aa081a1/)

(back to top)

## 🔭 Future Features

- [ ] **Adding category to a task**

(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...

(back to top)

## 🙏 Acknowledgments

I would like to thank...

(back to top)

## ❓ FAQ (OPTIONAL)

- **How can I use this project**

- It's a project creative commons, you can use if you give back the credit to the developers

(back to top)

## 📝 License

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

(back to top)