Victor-chiemerie/Leaderboard

[Leaderboard Scores] is a Webpage that requests and sends data from an API and load that data to the Webpage

📗 Table of Contents

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

📖 [Leaderboard Scores]

[Leaderboard Scores] is a Webpage that requests and sends data from an API and load that data to the Webpage

🛠 Built With

Client

• HTML
• CSS
• JavaScript
• Webpack

Database

• Leaderboard API

Testing

• linters

Key Features

• [Sends and receives data from an API]
• [Refreshes the Webpage when the API has been Updated]

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

• git: A tool for managing source code
• Visual Studio Code: A source code editor
• Live Server: A simple web server utility for Visual Studio Code

Setup

Clone this repository to your desired folder: https://github.com/Victor-chiemerie/Leaderboard.git

Install

Install this project with:

• cd my-folder
• git https://github.com/Victor-chiemerie/Leaderboard.git

Usage

To run the project, execute the following command:

• Open the cloned folder on the VS code
• Open the live server or
• Open a new Terminal and run npm start

Example command: on your terminal run

  rnpm start

Run tests

To run tests, run the following command:

• To check for stylelint errors, run npx stylelint "**/*.{css,scss}"
• To check for javascript error, run npx eslint .

Example command:

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

Deployment

You can deploy this project using:

• Github pages

Github pages

follow these steps for example

(back to top)

👥 Author

Mention all of the collaborators of this project.

👤Nwadinigwe Victor

• GitHub: @Bobby
• Twitter: @Bobby
• LinkedIn: @Bobby

(back to top)

🔭 Future Features

• [Implement an alphabetical arrangement when 2 scores have the same value]
• [Add more Object properties to the player object]

(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 star⭐️ the project. Joshua Lyngdoh has been of tremendous help so far.

(back to top)

🙏 Acknowledgments

I would like to appreciate Microverse for providing the resources and the platform for us to be a Professional full-stack developer.

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

• [Are you sure that you are owner of this work]

  • [Yes, I am]

• [Can you make the work to be responsive]

  • [yes]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)