🏆 Leaderboard App🏆

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
  • API Documentation
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Leaderboard

This repository sets up the basic HTML, CSS and JavaScript for a leaderboard feature on a website. The leaderboard displays recent scores and allows users to submit their own scores, which are then added to the leaderboard in descending order.

🛠 Built With

Tech Stack

• Client: HTML, CSS, JavaScript.
• Server: Not applicable
• Database: Not applicable

Client

• HTML
• CSS
• JavaScript

The project was built using the following technologies:

• HTML
• CSS
• JavaScript

(back to top)

Key Features

• View recent scores
• Submit your own score
• Sort scores in descending order
• Error handling for invalid input

(back to top)

🚀 Live Demo

• Click here to view the live Demo.

(back to top)

💻 Getting Started

To get a local copy of the project up and running, follow these steps.

Prerequisites

In order to run this project, you need to have a web browser installed on your computer.

Setup

Clone this repository to your desired folder by running the following command:

  clone git@github.com:MussieTeka/Leaderboard.git

Install

Run npm install to install all dependencies

  cd Leaderboard
  npm install

Usage

Run npm start to start the application using webapp live server.

  npm start

This will open the app in your browser at http://localhost:8081/

Run tests

To run tests for the Leaderboard App, follow these steps:

• Open the command prompt or terminal on your computer.
• Navigate to the project directory using the cd command.
• Type the command npm run test and press enter.

 npm run test

Deployment

You can deploy this project using any web hosting service of your choice.

API Documentation

See the API documentation for more information on the endpoints available.

(back to top)

👥 Author

This project was developed by:

👤 Mussie Kahsay - Developer

• GitHub: @MussieTeka
• Twitter: @mussieteka
• LinkedIn: @mussieteka

(back to top)

🔭 Future Features

• Implement a more advanced search system that allows users to filter scores.
• Add sorting and filtering options for the leaderboard table.
• Add user authentication to prevent duplicate or fake scores.
• Add ability to share scores on social media platforms.

(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 like this project, please give it a star on GitHub.

(back to top)

🙏 Acknowledgments

I would like to thank the following resources and individuals for their help and inspiration:

• Microverse, an online software engineering coding bootcamp.
• The Odin Project, a free open-source curriculum for learning web development.
• GitHub Pages, a free web hosting service.

(back to top)

❓ FAQ (OPTIONAL)

• Can I modify and redistribute this project?

  • Yes, you can modify and redistribute this project as long as you follow the terms of the MIT license.

• How can I contribute to this project?

  • Contributions, issues, and feature requests are welcome! You can check the issues page to see if there are any current issues or feature requests that you can work on. If not, feel free to submit a new issue or pull request. Before contributing, please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)