https://github.com/luigirazum/mv-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.
https://github.com/luigirazum/mv-leaderboard
api-rest async-await dom-manipulation es6-modules html-css-javascript
Last synced: 6 months 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.
- Host: GitHub
- URL: https://github.com/luigirazum/mv-leaderboard
- Owner: luigirazum
- License: mit
- Created: 2023-01-03T21:06:03.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-02-24T00:18:32.000Z (about 2 years ago)
- Last Synced: 2023-03-26T02:07:42.349Z (about 2 years ago)
- Topics: api-rest, async-await, dom-manipulation, es6-modules, html-css-javascript
- Language: JavaScript
- Homepage:
- Size: 1.1 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Leaderboard App
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.
Current Release v.1.0
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Leaderboard\] ](#-leaderboard-)
- [🛠 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)
- [Build](#build)
- [Run](#run)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [© Acknowledge ](#-acknowledge-)
- [⭐️ Show your support ](#️-show-your-support-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
**[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.
- **DOM Manipulation for Adding scores to the list.**
- **Dinamically adds current scores at loading.**
- **Use of an API.**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need `git` locally installed. Please got to [Getting Started - Installing Git guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and follow the steps described for your system to install `git`.
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone [email protected]:luigirazum/mv-leaderboard.git
```
### Install
Install this project with:
```sh
cd mv-leaderboard
npm install
```
### Build
To build the project, execute the following command:
```sh
npm run build
```
### Run
To run tests, run the following command:
```sh
npm start
```
### Deployment
You can deploy this project using:
```sh
npm deploy
```
👨💻 Luis Zubia
- GitHub: @luigirazum
- Twitter: @LuigiRazum
- LinkedIn: Luis Raul Zubia Maciel
- [ ] **Add some badges to players according to their score.**
In order to improve this project, contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Thanks to Muhamad Fandi, he is the one who create the amazing background image, you can [click here](https://www.vecteezy.com/members/fandi-creations) to discover more of his work.
Also, you can find more background like this in [vecteezy](https://www.vecteezy.com/free-vector/pixel-game-background).
I really enjoyed making this project, so, if you like it, I appreciate your support giving me a ⭐.
- **Why should you use this project?**
- Because you can realize what you can achieve using this amazing tool.
- **Why did I make this project?**
- In order to start putting in practice the use of WebPack, JS ES6 modules and API's.
This project is [MIT](./LICENSE) licensed.