https://github.com/jaujau088/leaderboard-with-api
A single page web app that displays scores submitted by different players. All data is preserved thanks to the external Leaderboard API service.
https://github.com/jaujau088/leaderboard-with-api
es6 html javascript leaderboard-api microverse rest-api scss webpack
Last synced: 2 months ago
JSON representation
A single page web app that displays scores submitted by different players. All data is preserved thanks to the external Leaderboard API service.
- Host: GitHub
- URL: https://github.com/jaujau088/leaderboard-with-api
- Owner: JauJau088
- Created: 2022-05-10T09:37:43.000Z (about 4 years ago)
- Default Branch: dev
- Last Pushed: 2022-05-23T11:12:13.000Z (about 4 years ago)
- Last Synced: 2025-08-06T08:42:06.971Z (11 months ago)
- Topics: es6, html, javascript, leaderboard-api, microverse, rest-api, scss, webpack
- Language: JavaScript
- Homepage:
- Size: 476 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Leaderboard
> The leaderboard is a website that 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://www.notion.so/microverse/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3).
## Built With
- HTML
- SCSS
- JavaScript (ES6)
- Webpack
- REST API
## Live Demo
:fire::fire: https://jaujau088.github.io/leaderboard-with-api/dist/ :fire::fire:
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
- Node.js
- npm
### Setup
- Clone the project
```terminal
git clone git@github.com:JauJau088/leaderboard-with-api.git
```
- cd into the project directory
```terminal
cd leaderboard-with-api
```
- Once you've cloned the repo and are inside the directory, run `npm install` command to get all necessary installations.
- Build/ watch project (not necessary, but might be needed in case you make some changes in the src folder).
```terminal
npm run build
npm run watch
```
- **Congratulations!** you are all set and you can open the project using a live sever extension from your code editor
- or you can also use Webpack's live server by simply typing
```terminal
npm start
```
## Author
👤 **Jauhari Alafi**
- GitHub: [@JauJau088](https://github.com/JauJau088)
- Twitter: [@jaujauj](https://twitter.com/jaujauj)
- LinkedIn: [Jauhari Alafi](https://linkedin.com/in/jauhari-alafi/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc.
## 📝 License
This project is [MIT](./MIT.md) licensed.