Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mailsg/leaderboard

The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved to the external Leaderboard API service.
https://github.com/mailsg/leaderboard

Last synced: 7 days ago
JSON representation

The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved to the external Leaderboard API service.

Host: GitHub
URL: https://github.com/mailsg/leaderboard
Owner: mailsg
License: mit
Created: 2023-05-22T10:04:31.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-05-25T10:27:07.000Z (over 1 year ago)
Last Synced: 2024-12-08T14:41:29.447Z (2 months ago)
Size: 626 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

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)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 The Leaderboard 

**The leaderboard** website displays scores submitted by different players. It also allows you to submit your score. All data is preserved to the external Leaderboard API service.

## 🛠 Built With 

### Tech Stack 

  HTML/CSS/JavaScript

  


    Javascript

  


  GitHub

  


    Github

  


### Key Features 

- **Interactive Webpage**

- **Add/Remove Scores**

- **API Interaction**

- **Webpack**

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

- a browser

- git

- nodejs

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:mailsg/Leaderboard.git

```

### Install

Install this project with:

```sh

  cd Leaderboard

  npm install

  npm run start

```

### Usage

To run the project, execute the following command:

```sh

  Open index.html in browser

  or

  Open with Live server in Vscode

```

### Run tests

To run tests, run the following command:

```sh

  npx stylelint "**/*.{css,scss}"

  npx hint .

  npx eslint .

```  

(back to top)


## 👥 Author 

👤 **Sandeep**

- GitHub: [@mailsg](https://github.com/mailsg)

(back to top)


## 🔭 Future Features 

- [ ] **Profile Section**

- [ ] **News Section**

- [ ] **Join Section**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [https://github.com/mailsg/Leaderboard/issues](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project give me a follow and/or a star

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for giving this opportunity to me to showcase my dev skills.

(back to top)


## 📝 License 

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

(back to top)