https://github.com/degisew/leaderboard-api
This is a website built with HTML5, CSS, modern JavaScript and WebPack bundler that displays scores submitted by different players. It also allows you to submit your score and all data is preserved on the external Leaderboard API service.
https://github.com/degisew/leaderboard-api
html5 javascript scss webpack
Last synced: about 2 months ago
JSON representation
This is a website built with HTML5, CSS, modern JavaScript and WebPack bundler that displays scores submitted by different players. It also allows you to submit your score and all data is preserved on the external Leaderboard API service.
- Host: GitHub
- URL: https://github.com/degisew/leaderboard-api
- Owner: degisew
- License: mit
- Created: 2022-08-31T12:49:29.000Z (almost 4 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-31T13:34:58.000Z (over 3 years ago)
- Last Synced: 2025-04-07T06:37:01.699Z (about 1 year ago)
- Topics: html5, javascript, scss, webpack
- Language: SCSS
- Homepage: https://degisew-leaderboard.netlify.app/
- Size: 299 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
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](#faq)
- [📝 License](#license)
**Leaderboard-API** is a website built with HTML5, SCSS, modern JavaScript and WebPack bundler that displays scores submitted by different game players. It also allows you to submit your score and all data is preserved on the external Leaderboard API service.
## 🛠 Built With
- HTML5
- SCSS
- Modern JavaScript
- Webpack Bundler
Client
Server
- Not available yet!
Database
- Not available yet!
- **Users can add player name and score**
- **Users can see all scores per player**
## 🚀 Live Demo
- [Live Demo Link](https://degisew-leaderboard.netlify.app/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- To have updated Browser installed on your machine
### Setup
Clone this repository to your desired folder:
```sh
git clone 'https://github.com/degisew/Leaderboard-API'
cd Leaderboard-API
```
### Install
Install this project with:
```sh
cd Leaderboard-API
npm install
```
### Usage
- To run the project, run the command below:
```sh
npm start
```
### Run tests
- No tests available yet!
### Deployment
You can deploy this project using:
- [GitHub Pages](https://pages.github.com/)
- [Netlify](https://app.netlify.com/)
👤 **Degisew**
- Location: Ethiopia
- GitHub: [degisew](https://github.com/degisew)
- Twitter: [@DJ_etiya](https://twitter.com/@DJ_etiya)
- LinkedIn: [degisew-mengist](https://www.linkedin.com/in/degisew-mengist)
- [ ] **We will work on the website look and feel to make it more interactive**
- [ ] **We will implement it on our API**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/degisew/Leaderboard-API/issues).
If you like this project, Kindly give a ⭐ to the repo.
- I would like to thank Microverse and my Coding Partners.
This project is [MIT](https://github.com/degisew/Leaderboard-API/blob/dev/LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._