Skip to content

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.

Notifications You must be signed in to change notification settings

MoyasiGinko/Leaderboard-Project

Repository files navigation

logo

Leaderboard

📗 Table of Contents

📖 Leaderboard

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.

🛠 Built With

  • API
  • HTML
  • CSS
  • JavaScript (ES6)
  • Webpack
  • Jest

Tech Stack

Languages and technologies

Key Features

  • Easy navigation
  • Real-Time Updates
  • Customizable Leaderboard Views

🚀 Live Demo

Demo Link 🔥

(back to top)

💻 Getting Started

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 git@github.com: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.

(back to top)

👷‍♂️ Author

👤 Moyasi

(back to top)

🔭 Future Features

  • [Interactive Functions]
  • [User Profiles]
  • [Achievements and Badges]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you get inspired by this project you can give me a star 🙌

(back to top)

🙏 Acknowledgments

I would like to thank Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)

About

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.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published