Leaderboard App

The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.

Current Release v.1.0

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Leaderboard]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Build
    • Run
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • © Acknowledge
  • ⭐️ Show your support
  • ❓ FAQ
  • 📝 License

📖 [Leaderboard]

[Leaderboard] website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.

🛠 Built With

Tech Stack

• HTML
• CSS
• Javascript
• WebPack

Key Features

• DOM Manipulation for Adding scores to the list.
• Dinamically adds current scores at loading.
• Use of an API.

(back to top)

🚀 Live Demo

• Leaderboard - Live Demo

(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 git locally installed. Please got to Getting Started - Installing Git guide and follow the steps described for your system to install git.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:luigirazum/mv-leaderboard.git

Install

Install this project with:

  cd mv-leaderboard
  npm install

Build

To build the project, execute the following command:

  npm run build  

Run

To run tests, run the following command:

  npm start

Deployment

You can deploy this project using:

  npm deploy

(back to top)

👥 Authors

👨‍💻 Luis Zubia

• GitHub: @luigirazum
• Twitter: @LuigiRazum
• LinkedIn: Luis Raul Zubia Maciel

(back to top)

🔭 Future Features

• Add some badges to players according to their score.

(back to top)

🤝 Contributing

In order to improve this project, contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

© Acknowledge

Thanks to Muhamad Fandi, he is the one who create the amazing background image, you can click here to discover more of his work.

Also, you can find more background like this in vecteezy.

(back to top)

⭐️ Show your support

I really enjoyed making this project, so, if you like it, I appreciate your support giving me a ⭐.

(back to top)

❓ FAQ

• Why should you use this project?

  • Because you can realize what you can achieve using this amazing tool.

• Why did I make this project?

  • In order to start putting in practice the use of WebPack, JS ES6 modules and API's.

(back to top)

📝 License

This project is MIT licensed.

(back to top)