📖 Leaderboard Project

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.This project would help you get started working with API's in JavaScript.

📗 Table of Contents

• 📖 Leaderboard Project
• 📗 Table of Contents
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Install
    • Usage
    • Deployment
  • Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

🛠 Built With

Tech Stack

• HTML
• CSS
• JavaScript
• Webpack

Server

• Netlify

Database

• API

Key Features

Add Scores The leaderboard API allows users to add scores, providing a way for them to track and share their progress and achievements. This feature is essential for any competitive or gamified application that requires users to keep track of their scores or rankings.

View Scores The leaderboard API also allows users to view scores of other users, creating a sense of community and competition. This feature is important for fostering engagement and interaction among users, as they can compare their scores with others and strive to improve their rankings.

(back to top)

🚀 Live Demo

• Project Link

(back to top)

💻 Getting Started

• Open GitHub URL of repositry.

• Download Code repo in zip.

• Extract and open repo folder into visual studio code or any other Text Editor Software.

• GitHub Repositry URL: https://github.com/admirerbrown/leaderboard-api-project.git To get a local copy up and running follow these simple example steps.

  git clone https://github.com/admirerbrown/leaderboard-api-project.git

Prerequisites

• Visual Studio Code
• Knowldege About HTML / CSS / JAVASCRIPT ES6
• Webhint
• Stylelint
• ESLint
• node_modules checker
• Github
• knowledge of webpack

Install

Install this project with:

  npm install

Usage

To run the project in a development server, execute the following command:

  - run npm run build
  - run npm run dev

Deployment

You can deploy this project using:

https://netlify.app/ OR GITHUB PAGES

(back to top)

Authors

👤 Samuel Kyere

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Implement some UX improvements: added transitions and/or animation.
• Implement additional pages.

(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 follow me on github and give stars to my repo.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing me with the resources and guiding me to complete this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)