README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run Linters
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

🧑‍💻 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.

Leaderboard is a vanilla-js blog website.

🛠 Built With

Tech Stack

Leaderboard is front-end project

Technologies

• HTML
• SASS/SCSS
• JavaScript
• Webpack

Key Features

We can see the event details and can connect with the organizers and speakers.

(back to top)

🚀 Live Demo

• See Project 🚀

(back to top)

💻 Getting Started

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

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👨‍💻 Aakash Verma

• GitHub: @skyv26
• Twitter: @vrma_aakash
• LinkedIn: skyv2022
• Frontend Mentor: @skyv26

(back to top)

🔭 Future Features

In upcoming weeks I will add some features as mentioned below

• Add full features like sign-up, sign-in and API

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

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.

(back to top)

Acknowledgments

Thanks to everyone who helped me ❤️

(back to top)

📝 License

This project is MIT licensed.

(back to top)