https://github.com/dennis-every/leaderboard

Leaderboard is a website which 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/dennis-every/leaderboard

css gitflow html javascript

Last synced: about 1 month ago
JSON representation

Leaderboard is a website which 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/dennis-every/leaderboard
• Owner: dennis-every
• License: mit
• Created: 2023-01-31T21:25:24.000Z (almost 2 years ago)
• Default Branch: development
• Last Pushed: 2023-02-01T21:08:54.000Z (almost 2 years ago)
• Last Synced: 2024-12-01T16:41:43.451Z (about 1 month ago)
• Topics: css, gitflow, html, javascript
• Language: JavaScript
• Homepage: https://dennis-every.github.io/Leaderboard/dist
• Size: 463 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  
LEADERBOARD

  


  

  







# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 About ](#-about-)

  - [🛠 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)

  - [👥 Author ](#-author-)

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

  - [🤝 Contributing ](#-contributing-)

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

  - [🙏 Acknowledgments ](#-acknowledgments-)

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

  - [📝 License ](#-license-)

# 📖 About 

**Leaderboard** is a website which 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.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
JavaScript

  

  


    
HTML

  

  


    
CSS

  


  Server

  


    
N/A

  


Database

  


    
N/A

  


### Key Features 

- **Leaderboard displays the scores submitted by different players**

- **Leaderboard allows you to submit your score**

- **Leaderboard data is preserved thanks to the external Leaderboard API service**

(back to top)


## 🚀 Live Demo 

- [Leaderboard](https://dennis-every.github.io/Leaderboard/dist)

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

- Connection to internet.

### Setup

Clone this repository to your desired folder:

- git clone https://github.com/dennis-every/Leaderboard.git

- Open the files in your text editor.

### Install

You don't need to install anything.

### Usage

To run the project, execute the following command:

- npm install

- npm start

(back to top)


## 👥 Author 

👤 **Dennis Every**

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

(back to top)


## 🔭 Future Features 

- [ ] **Add functionalities to add scores through the form**

- [ ] **Add functionalities to upload and retrieve scores from the 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 feel free to fork it and use it as you need.

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the information provided to build this project.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **Can I use the project for any purpose?**

  - Yes, you can use this files for anything you need

- **Is the information saved in any database?**

  - No, all data is saved in the Leaderboard API

(back to top)


## 📝 License 

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

(back to top)