Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iturres/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 - (Link in README file). Check it out! 👇
https://github.com/iturres/leaderboard
api javascript linters sass webpack
Last synced: 8 days 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 - (Link in README file). Check it out! 👇
- Host: GitHub
- URL: https://github.com/iturres/leaderboard
- Owner: ITurres
- License: other
- Created: 2023-06-20T16:07:56.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2024-02-28T00:16:00.000Z (11 months ago)
- Last Synced: 2025-01-09T13:31:54.827Z (21 days ago)
- Topics: api, javascript, linters, sass, webpack
- Language: JavaScript
- Homepage: https://iturres.github.io/Leaderboard/dist/
- Size: 393 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Leaderboard
---
# 📗 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](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
---
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://microverse.notion.site/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3).
---
#### Learning objectives
- Use medium-fidelity wireframes to create a UI.
- Use callbacks and promises.
- Use proper ES6 syntax.
- Use ES6 modules to write modular JavaScript.
- Use webpack to bundle JavaScript.
- Send and receive data from an API.
- Use API documentation.
- Understand and use JSON.
- Make JavaScript code asynchronous.
---
Markup
Dynamic
Styles
Bundler
---
- **Dynamic Injection of HTML Markup**
- **API consumption**
---
- [Live Demo Link](https://iturres.github.io/Leaderboard/dist/)
---
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- WebPack
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
cd my-folder
git clone [email protected]:ITurres/Leaderboard.git
```
### Install
Install this project with:
```bash
npm install
```
### Usage
To run the project, execute the following command:
```bash
npm run start
```
#### Run with no bundler:
- LiveServer or the like on the `dist/index.html`
### Run tests
To run tests, run the following command:
- Not Applicable
### Deployment
You can deploy this project using:
- Not Applicable
---
👤 **Author1**
- GitHub: [@ITurres](https://github.com/ITurres)
- Twitter: [@Arthur_ITurres](https://twitter.com/ArthurIturres)
- LinkedIn: [Arthur Emanuel G. Iturres](https://www.linkedin.com/in/arturoemanuelguerraiturres/)
---
- [x] all fulfilled.
---
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
---
Give a ⭐ if you liked this project!
---
I thank Microverse for this fantastic opportunity, the code reviewers for their advice and time 🏆
---
This project is [MIT](./LICENSE.md) licensed.
---