dennis-every/leaderboard

Leaderboard is a website which 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.

LEADERBOARD

📗 Table of Contents

• 📗 Table of Contents
• 📖 About
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 About

Leaderboard is a website which 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

Client

• JavaScript

• HTML

• CSS

Server

• N/A

Database

• N/A

Key Features

• Leaderboard displays the scores submitted by different players
• Leaderboard allows you to submit your score
• Leaderboard data is preserved thanks to the external Leaderboard API service

(back to top)

🚀 Live Demo

• Leaderboard

(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:

• A working computer.
• Connection to internet.

Setup

Clone this repository to your desired folder:

• git clone https://github.com/dennis-every/Leaderboard.git
• Open the files in your text editor.

Install

You don't need to install anything.

Usage

To run the project, execute the following command:

• npm install
• npm start

(back to top)

👥 Author

👤 Dennis Every

• GitHub: @dennis-every

(back to top)

🔭 Future Features

• Add functionalities to add scores through the form
• Add functionalities to upload and retrieve scores from the 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

If you like this project feel free to fork it and use it as you need.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the information provided to build this project.

(back to top)

❓ FAQ (OPTIONAL)

• Can I use the project for any purpose?

  • Yes, you can use this files for anything you need

• Is the information saved in any database?

  • No, all data is saved in the Leaderboard API

(back to top)

📝 License

This project is MIT licensed

(back to top)