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

https://github.com/cobbyelsonfx/leaderboard-api

The 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/cobbyelsonfx/leaderboard-api

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 thanks to the external Leaderboard API service.

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)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 About the Project

**Leaderboard** The 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.
## 🛠 Built With

### Tech Stack

Client

### Key Features

- **Displays Added Scores**
- **Ability to add a new scores**
- **Consumes an API**

(back to top)

## 🚀 Live Demo

- [Live Project](https://cobbyelsonfx.github.io/Leaderboard-API/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:

- An IDE (ex: VS Code)
- Github account

### Setup

Clone this repository to your desired folder:

```sh
cd project-folder
git clone https://github.com/CobbyElsonfx/Leaderboard-API.git
```

### Deployment

You can deploy this project using:

- Go to github.com
- Create a new repository
- Add all website files in the new repository
- Go to Settings/Pages
- Go to branch and change from 'none' to 'main'
- Click Save

(back to top)

## 👥 Authors

👤 **Francis Andoh**

- GitHub: [@CobbyElsonfx](https://github.com/CobbyElsonfx)
- LinkedIn: [@FrancisAndoh](https://www.linkedin.com/in/francis-andoh-133aa7245/)

(back to top)

## 🔭 Future Features

- [ ] **More animation**

(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 and wish to collaborate. Please contact me.

(back to top)

## ❓ FAQ

- **Is it responsive?**

- Yes,it works both on mobile and desktop screens.

(back to top)

## 📝 License

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

(back to top)