Leaderboard

📗 Table of Contents

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

📖 Leaderboard

This project is a Single Page Application (SPA) that interacts with a Leaderboard API to display a list of players' names and scores. Users can add new players' scores to the list, which is then stored in the API.

The project uses Webpack for bundling and optimizing code. Webpack allows you to combine all your JavaScript modules into a single file, reducing the number of HTTP requests required to load a web page. This results in a faster and more responsive web page for users.

The project is designed to provide a hands-on learning experience for those interested in learning about APIs, Git workflow, and Webpack. Through this project, users will learn how to fetch data from a remote server, manipulate the DOM to display the data, and send data back to the server to be stored. They will also learn how to use Git for version control, including creating and managing branches, committing changes, and merging them back into the main branch.

Overall, this project is a great way to gain practical experience in web development and gain valuable knowledge that can be applied to other projects in the future.

🛠 Built With

Tech Stack

Client

This project only works client side right now.

• HTML
• CSS
• JS
• Webpack
• API

Key Features

• Allows add players
• Allows add score
• shows recent score by name

(back to top)

🚀 Live Demo

• Live 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:

It would be best if you had some familiarity with HTML, CSS, and JS.

• A Computer (MAC or PC)
• code editor (VSCode,Atom etc...)
• A browser (Chrome,Mozilla,Safari etc...)
• Version Control System (Git and Github)

Setup

Clone this repository to your desired folder:

       git clone https://github.com/AbdusSattar-70/Leaderboard.git
       cd Leaderboard 

Install

Install this project with:

     npm install

Usage

You can use it to store game data in a remote location and see when you want for fun!

Run tests

To run tests, run the following command:

• To check Styelint error:-

   npx stylelint "\*_/_.{css,scss}"

• To check Eslint error:-

  npx exlint .

• To check webhint error:-

  npx hint .

Deployment

You can deploy this project using:

   npm run build

(back to top)

👥 Authors

👤 Abdus Sattar

• GitHub: AbdusSattar-70
• Twitter: Abdus Sattar
• LinkedIn: Abdus Sattar

(back to top)

🔭 Future Features

• Implement the ability to delete data from the Leaderboard API.
• Implement PUT and PATCH requests to update existing data in the API.
• Improve the visual design of the application to create a more aesthetically pleasing and user-friendly experience.
• This could include the use of advanced CSS techniques, animations, and custom graphics to make the application look more luxurious and modern.

(back to top)

🤝 Contributing

Everybody is welcome to suggest, changes,Contributions, issues, and feature request in this repo.

In order to do it, fork this repository, create a new branch and open a Pull Request from your branch.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, Please give me ⭐️ and you can use it following MIT license.

(back to top)

🙏 Acknowledgments

Thanks ❤️ to all of my coding partners, team members, and specifically Microverse code reviewers to help me to figure issues out.

I would like to thank and appreciate who contributes this project.

(back to top)

📝 License

This project is under MIT licensed.

(back to top)