Leaderboard

📗 Table of Contents

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

📖 Leaderboard

Leaderboard is a simple list app that displays a list of users and their game scores data which is manipulated by an API using JavaScript async and await.

🛠 Built With

Tech Stack

Client

• HTML5
• CSS
• JavaScript

Key Features

• Javascript Async and Await

• ES6

• Webpack

• Gitflow

(back to top)

🚀 Live Demo

• Visit the live demo here

(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 browser (e.g. Firefox)
• An IDE (e.g. Vususal Studio Code)
• npm
• Webpack

Setup

To clone this repository to your desired folder, follow the steps below:

Using the command line

• Use the following commands

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

Using GitHub Desktop app

• Follow the steps below

  • Visit this link "https://github.com/Timbar09/Leaderboard.git"
  • Click the green button labelled "code"
  • Select the "Open with GitHub Desktop" option
  • After the GitHub Desktop add opens, click the "clone repo" button

Install

Install this project's dependencies with the following command:

  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project by:

• visiting your repository on GitHub
• Click on settings
• Go to the "Pages" option
• Select the main branch and save

(back to top)

👥 Author

👤 Author	GitHub	Twitter	LinkedIn
Miles Mosweu	@Timbar09	@Milez09	@miles09

|

(back to top)

🔭 Future Features

• Implement more functionality.

(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, give it a ⭐️ and let me know what you like in particular.

(back to top)

🙏 Acknowledgments

I would like to thank the whole Microverse community for their help and contributions towards this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)