Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stephenkati/leaderboard

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

game player-rating score scoreboard

Last synced: 5 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/stephenkati/leaderboard
Owner: stephenkati
License: mit
Created: 2023-03-06T14:35:01.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-03-10T06:37:23.000Z (over 1 year ago)
Last Synced: 2024-11-01T23:41:58.742Z (12 days ago)
Topics: game, player-rating, score, scoreboard
Language: JavaScript
Homepage: https://stephenkati.github.io/Leaderboard/dist/
Size: 287 KB
Stars: 12
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

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)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [Video-presentation](#presentation)

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

- [📝 License](#license)

# 📖 [LEADERBOARD] 

 **[LEADERBOARD]** website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service. Build with HTML, CSS and Javascript.

## 🛠 Built With 

### Tech Stack 

  Client

  


    HTML 

    CSS

    JavaScript

    webpack

  


  Server

  


    No Server build yet

  


Database

  


    No database build yet

  


### Key Features 

> Describe between 1-3 key features of the application.

- **[Used Linters]**

- **[Great summary for the repo]**

- **[Use of GitFlow]**

- **[Leaderboard API]** Using  this  API, a user can send and retrieve user and score information.

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](Not deployed yet)

(back to top)


## 💻 Getting Started 

A new developer can get the project from my Github repo link i shall provide.

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

go to https://github.com/stephenkati/Leaderboard.git

clone or download the project

Run it in your favourite browser

### Prerequisites

In order to run this project you need:

-A code editor, preferably VSCode. Any other code editor is okay.

-Browser

### Setup

Clone this repository to your desired folder:

run git clone https://github.com/stephenkati/Leaderboard.git

or

In the File menu, click Clone Repository.

Click the tab that corresponds to the location of the repository you want to clone. You can also click URL to manually enter the repository location.

Choose the repository you want to clone from the list.

Click Choose... and navigate to a local path where you want to clone the repository.

Click Clone.

### Install

Install this project with:

Download the project from github and run it in your browser.

Install webpack dependencies.

npm init -y

npm install webpack webpack-cli --save-dev

Install html webpack plugin

npm install --save-dev html-webpack-plugin

Install css loader

npm install --save-dev style-loader css-loader

### Usage

To run the project, navigate to the project directory and use a live Server extension in your VSCode to run the project.

Run npm start 

or 

npm run build then select dist file.

### Run tests

You can run tests to check for linter errors by running the following commands:

- npx stylelint "**/*.{css,scss}" for testing css errors

- npx eslint . for Javascript errors

### Deployment

The project is not yet deployed.

(back to top)


## 👥 Authors 

👤 **Stephen Katuli**

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

- Twitter: [@twitterhandle](https://twitter.com/Stephen57913145)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-katuli-a92752251/)

(back to top)


## 🔭 Future Features 

- [ ] **[More backround images]**

- [ ] **[Animations and transitions]**

- [ ] **[More Javascript Functionality]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project please reach out to me on my social media, hire me for more content like this.

(back to top)


## 🙏 Acknowledgments 

I would like to thankmy Microverse team and my coding partners for their support and guidance.

(back to top)


##  PRESENTATION  

**PROJECT PRESENTATION VIDEO**

No presentation done yet.

## ❓ FAQ (OPTIONAL) 

- **[How good are your communication skills?]**

  - [I have good writting and speaking communication skills in English.]

- **[What else do you do apart from coding?]**

  - [I do graphics design.]

(back to top)


## 📝 License 

This project is  MIT  licensed.

(back to top)