https://github.com/moyasiginko/leaderboard-project
A leaderboard project on GitHub using an API involves creating a platform to track and display the rankings or scores of participants in a specific activity or competition. The project typically utilizes an API (Application Programming Interface) to retrieve data related to the participants' scores or rankings.
https://github.com/moyasiginko/leaderboard-project
css html javascript json-api linters webpack
Last synced: about 1 month ago
JSON representation
A leaderboard project on GitHub using an API involves creating a platform to track and display the rankings or scores of participants in a specific activity or competition. The project typically utilizes an API (Application Programming Interface) to retrieve data related to the participants' scores or rankings.
- Host: GitHub
- URL: https://github.com/moyasiginko/leaderboard-project
- Owner: MoyasiGinko
- Created: 2023-05-24T18:28:37.000Z (almost 2 years ago)
- Default Branch: development
- Last Pushed: 2023-05-25T22:24:20.000Z (almost 2 years ago)
- Last Synced: 2025-01-28T21:34:57.429Z (3 months ago)
- Topics: css, html, javascript, json-api, linters, webpack
- Language: CSS
- Homepage: https://moyasiginko.github.io/Leaderboard-Project/dist/
- Size: 168 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.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](#run-tests)
- [👷♂️ Author](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**Leaderboard**
> A leaderboard project on GitHub using an API involves creating a platform to track and display the rankings or scores of participants in a specific activity or competition. The project typically utilizes an API (Application Programming Interface) to retrieve data related to the participants' scores or rankings. In this particular repo, We are building this leaderboard with using API, HTML, CSS, JavaScript (ES6), and Webpack.
- API
- HTML
- CSS
- JavaScript (ES6)
- Webpack
- Jest
Languages and technologies
- **Easy navigation**
- **Real-Time Updates**
- **Customizable Leaderboard Views**
[Demo Link 🔥](https://moyasiginko.github.io/Leaderboard-Project/dist/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need GitHub account and a text editor.
- Node.js
- npm
### Setup
Clone this repository to your desired folder:
```
git clone [email protected]:MoyasiGinko/Leaderboard-Project.git
cd Leaderboard-Project
```
- cd into the project directory
```
Open the project using a live sever extension that can be found within your code editor extensions.
```
### Install
- Once you clone the repo, go to the directory and run `npm install` command to get all necessary instalations.
- Build/ watch project (not necessary, but might be needed in case you make some changes in the src folder).
```
npm run build
npm run watch
```
- Run Webpack live server
```
npm start
```
### Usage
To run the project, execute the following command:
N/A
### Run tests
```
npm run test
```
- ...in your bash (assuming you are in the root of this project);
### Deployment
You can deploy this project using: webpack in your local machine.
👤 **Moyasi**
- GitHub: [@MoyasiGinko](https://github.com/MoyasiGinko)
- Twitter: [@MoyasiGinko](https://twitter.com/moyasi_ginko)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mahmudur-rahman-a8a151257)
- [ ] **[Interactive Functions]**
- [ ] **[User Profiles]**
- [ ] **[Achievements and Badges]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you get inspired by this project you can give me a star 🙌
I would like to thank Microverse
This project is [MIT](./MIT.md) licensed.