https://github.com/skyv26/leaderboard
This project aims to create a leaderboard system to track and display user performance in an engaging way. Through the use of an interactive and intuitive interface, users can quickly and easily view scores and rankings of their peers. The leaderboard system is driven by a backend database.
https://github.com/skyv26/leaderboard
javascript webpack
Last synced: 2 months ago
JSON representation
This project aims to create a leaderboard system to track and display user performance in an engaging way. Through the use of an interactive and intuitive interface, users can quickly and easily view scores and rankings of their peers. The leaderboard system is driven by a backend database.
- Host: GitHub
- URL: https://github.com/skyv26/leaderboard
- Owner: skyv26
- License: mit
- Created: 2022-08-25T17:42:41.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-08T11:18:57.000Z (about 3 years ago)
- Last Synced: 2025-04-02T07:15:51.535Z (over 1 year ago)
- Topics: javascript, webpack
- Language: JavaScript
- Homepage: https://skyv26.github.io/leaderboard/
- Size: 367 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 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 Linters](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
> **This project aims to create a leaderboard system to track and display user performance in an engaging way. Through the use of an interactive and intuitive interface, users can quickly and easily view scores and rankings of their peers. The leaderboard system is driven by a backend database.**
**Leaderboard** is a vanilla-js blog website.
> Leaderboard is front-end project
Technologies
> We can see the event details and can connect with the organizers and speakers.
- [**See Project 🚀**](https://skyv26.github.io/leaderboard/)
> In order to start with this project do as follows :
To get a local copy up and running, follow these steps.
### Prerequisites
- use git clone in order to get the copy this repo. You need to have atleast basic understanding of JavaScript. Use below command
- git clone https://github.com/skyv26/leaderboard.git
### Setup
- You can simply open it on your vscode in order to start working on it
- cd leaderboard
### Install
- please first install the node package files
- npm install
### Usage
- In order to use this project you either create branch to add more feature.
- But in order to run the project use below commands.
- npm run build **(It will create a production ready file)**
- npm start **(It will run the server on your machine)**
### Run Linters
I have added the linters or tests in order to avoid anykind of typos and ensure the good practices in this project. So while using this repository if you need to check your work no matters have worked on html, css and js you can use below commands
- In order to run the linter test on `index.html` or any html file. Use below command
`npx hint .`
- To run linter test on stylesheets. Use below command
`npx stylelint "**/*.{css,scss}"`
- To run linter test on javascript files. Use below command
`npx eslint .`
**it will automatically correct the errors**
> Mention all of the collaborators of this project.
👨💻 **Aakash Verma**
- GitHub: [@skyv26](https://github.com/skyv26)
- Twitter: [@vrma_aakash](https://twitter.com/vrma_aakash)
- LinkedIn: [skyv2022](https://linkedin.com/in/skyv2022)
- Frontend Mentor: [@skyv26](https://www.frontendmentor.io/profile/skyv26)
> In upcoming weeks I will add some features as mentioned below
- [ ] **Add full features like sign-up, sign-in and API**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> Write a message to encourage readers to support your project
If you like this project then please give a ⭐️ and also share your feedback using github_issues.
## Acknowledgments
Thanks to everyone who helped me ❤️
This project is [MIT](./LICENSE) licensed.