NoelLincoln / Leaderboard

Save scores and display scores submitted by players using the leaderboard API

Leaderboard

📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• ❓ FAQ (OPTIONAL)

• 📝 License

📖 Leaderboard

Leaderboard is an application that enables players to save scores and display scores submitted by players using the leaderboard API .

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• Javascript

Tools

• Visual studio code

Key Features

• Minimalistic
• User-friendly

(back to top)

💻 Getting Started

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

Prerequisites

In order to set up and run the application you need:

• A code editor preferably Visual Studio Code
• A web browser preferably Google chrome.

Basic requirements are needed in order to fully understand how the project fully works :

• Basic knowledge of HTML, CSS, JS (JavaScript) and webpack.
• How to work with Git and GitHub.
• Basic knowledge of APIs.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/NoelLincoln/Leaderboard.git

Install

Install this project with:

  cd to-do-list
  npm install

Usage

To run the project run :

npm start

Run tests

To run tests, run the following command:

• To test css files run:

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

• To test javascript files run:

  npx eslint .

Deployment

You can deploy this project using GitHub Pages

(back to top)

👥 Authors

👤 Noel Bryant

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

🔭 Future Features

• Dark Mode

(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 contact me.

(back to top)

🙏 Acknowledgments

I would like to thank the entire Microverse community and family for the support and motivation.

(back to top)

License

📝 License

This project is MIT licensed.

(back to top)