https://github.com/yothu/leaderboard-api-project
Leaderboard web aplication, you can add scores.
https://github.com/yothu/leaderboard-api-project
api-client bootstrap5 html-css-javascript
Last synced: 8 months ago
JSON representation
Leaderboard web aplication, you can add scores.
- Host: GitHub
- URL: https://github.com/yothu/leaderboard-api-project
- Owner: Yothu
- Created: 2022-01-24T00:30:59.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2022-01-26T23:13:55.000Z (over 4 years ago)
- Last Synced: 2025-04-23T21:09:24.482Z (about 1 year ago)
- Topics: api-client, bootstrap5, html-css-javascript
- Language: JavaScript
- Homepage:
- Size: 580 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LEADERBOARD API - PROJECT
> Basic leaderboard that ranks based on scores.
> Project created to practice the use of Gitflow and the use of APIs.
## Built With
#### Languages:
- HTML
- CSS
- JavaScript
#### Technologies:
- Bootstrap
- Webpack
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
You need to be able to use Node Package Manager, or also called, the `npm` command.
If you dont have it, install it with these commands in the CLI (for Linux):
`curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -`
`sudo apt install nodejs`
Then, run this command in the CLI:
`npm --version`
If the previous command prints a single line with a version number on screen, `npm` was installed.
### Install
First you need to clone the repository into the folder of your choice with this command:
`git clone https://github.com/Yothu/leaderboard-api-project.git`
Then go inside the repository foler with this command:
`cd leaderboard-api-project`
After you are inside, download the `npm` dependecies with this command:
`npm install`
Finally, show the project through the browser with this command:
`npm start`
### Usage
Once you are in the browser with the page shown:
To add a new score to the leaderboard:
1. Put a `name` in the `top text input`.
2. Put a `number` in the `lower text input`.
3. Press the `submit button`, and a new score will be added to the leaderboard.
4. Press the `refresh button`, and all the scores storaged in the API will show in the leaderboard.
## Author
👤 David Vergaray
- GitHub: [@Yothu](https://github.com/Yothu)
- Twiter: [@Daivhy](https://twitter.com/Daivhy)
- LinkedIn: [David Vergaray](https://www.linkedin.com/in/david-vergaray-almontes-051a11127/)
## 📝 License
This project is [MIT](./MIT.md) licensed.
## Show your support
Give a ⭐️ if you like this project!