Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anselemodims/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/anselemodims/leaderboard
api async await javascript leaderboard rest service webpack
Last synced: about 13 hours 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/anselemodims/leaderboard
- Owner: AnselemOdims
- License: mit
- Created: 2021-12-12T09:59:59.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2021-12-16T08:45:27.000Z (almost 3 years ago)
- Last Synced: 2024-05-28T16:58:57.203Z (4 months ago)
- Topics: api, async, await, javascript, leaderboard, rest, service, webpack
- Language: JavaScript
- Homepage: https://anselemodims.github.io/LeaderBoard/
- Size: 4.8 MB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LeaderBoard
> The leaderboard website displays scores submitted by different players. It also allows you to submit your score.
## Mini Presentation
## Dark Mode
Additional description about the project and its features.
## Built With
- Major languages (HTML, CSS, JavaScript)
- Frameworks (None)
- Technologies used
``` bash
- Webpack(Code Bundlng et al)
- Git(version control)
- ESLint(JavaScript linting)
- WebHint(linting tool)
- Stylelint(style linting)
```
## Live Demo
[Live Demo Link](https://anselemodims.github.io/LeaderBoard/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- A text editor(preferably Visual Studio Code)
### Install
- [Git](https://git-scm.com/downloads)
- [Node](https://nodejs.org/en/download/)
### Usage
#### Clone this repository
```bash
$ git clone [email protected]:AnselemOdims/LeaderBoard.git
$ cd LeaderBoard
```
#### Run project
```bash
$ npm install
$ npm run start # this will make webpack watching for your changes in code
```
#### Open page in browser
```bash
$ open dist/index.html
```
## Interaction with the Leaderboard API
- Each new game is created with the POST method using
```bash
{
"name": "My cool new game"
}
```
This request returns a result that holds the unique ID for that game:
```bash
{
"result": "Game with ID: Zl4d7IVkemOTTVg2fUdz added."
}
```
> This gameID is saved in the localStorage automatically
The two allowed actions are posting and getting of the scores
- The POST request creates a new Leaderboard score for the given game sending user and score as parameters like this:
#### Endpoint
```bash
https://us-central1-js-capstone-backend.cloudfunctions.net/api/games/:id/scores/
```
body parameters
```bash
{
"user": "John Doe",
"score": 42
}
```
and it returns
```bash
{
"result": "Leaderboard score created correctly."
}
```
- The GET request returns data in JSON format like this:
#### Endpoint
```bash
https://us-central1-js-capstone-backend.cloudfunctions.net/api/games/:id/scores/
```
It returns
```bash
{
"result": [
{
"user": "John Doe",
"score": 42
},
{
"user": "Peter Parker",
"score": 35
},
{
"user": "Wonder Woman",
"score": 50
}
]
}
```
## Authors
👤 **Anselem Odimegwu**
- GitHub: [github](https://github.com/AnselemOdims)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/anselem-odimegwu-65a679104/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/AnselemOdims/LeaderBoard/issues).
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](https://opensource.org/licenses/MIT) licensed.