README.md

📗 Table of Contents

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

📖 [Leaderboard]

[Leaderboard] is an API based project that utilizes webpack and ES6 features, notably modules. It consumes the Leaderboard API using JavaScript async and await in a way that facilitates sending and receiving data from/to the Leaderboard API.

🛠 Built With

• [HTML]
• [CSS]
• [JavaScript]

Key Features

• [ Webpack and ES6 features-modules]
• [The Leaderboard API ]
• [Sending and receiving data from/to the Leaderboard API]

(back to top)

🚀 Live Demo

• Live Demo Link

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

• [Browser]
• [A source-code editor i.e VS code]
• [A terminal]
• [Npm]
• [Webpack]

Setup

Clone this repository to your desired folder:

Using the command line

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

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

• [ npm test ]

Deployment

You can deploy this project using:

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

(back to top)

👥 Authors

👤 Author1

• GitHub: @chepkok3
• Twitter: @chepkok3
• LinkedIn: @chepkok3

(back to top)

🔭 Future Features

• [ Adding more functionalities and features like time.]
• [ Live update of matches played.]
• [ Styling to make the page more presentable and attractive to users. ]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give it a ⭐️ and let me know what you like in particular if you like this project.

(back to top)

🙏 Acknowledgments

I would like to thank my coding partners and the Microverse team for the support they accorded to me during the development.

(back to top)

📝 License

This project is MIT licensed.

(back to top)