- 📖 About the Project
- 💻 Getting Started
- 👷♂️ Author
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- 📝 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
- Easy navigation
- Real-Time Updates
- Customizable Leaderboard Views
To get a local copy up and running, follow these steps.
In order to run this project you need GitHub account and a text editor.
- Node.js
- npm
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.
-
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
To run the project, execute the following command:
N/A
npm run test
- ...in your bash (assuming you are in the root of this project);
You can deploy this project using: webpack in your local machine.
👤 Moyasi
- GitHub: @MoyasiGinko
- Twitter: @MoyasiGinko
- LinkedIn: LinkedIn
- [Interactive Functions]
- [User Profiles]
- [Achievements and Badges]
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
If you get inspired by this project you can give me a star 🙌
I would like to thank Microverse
This project is MIT licensed.