banzaman / Leaderboard

Consuming the Leaderboard API using JavaScript async and await, adding some styling, using webpack and ES6 features.

README FILE

📗 Table of Contents

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

📖 [LEADERBOARD]

[LEADERBOARD] an app used to learn to send, receive data from an API, use API documentation, understand and use JSON and make JavaScript code asynchronous.

🛠 Built With

Tech Stack

Client

• HTML5
• CSS
• JS
• ESLint
• StyleLints
• GitFlow

Key Features

• [GIT FLOW]
• [Good HTML, JS and CSS practices]
• [Dynamically]

(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

If you haven't yet, you should first set up Git. Don't forget to set up authentication to GitHub.com from Git as well.

Usage

• Clone the repository

  • Above the list of files, click ↓Code
  • Clone with HTTPS
  • Open Terminal
  • Change the current working directory to the location where you want the cloned directory
  • Type git clone, and then paste the URL you copied earlier
  • Press Enter. Your local clone will be created

• Install webpack

  • Required to run npm init -y
  • Webpack npm install webpack webpack-cli --save-dev
  • HTML plugin npm install --save-dev html-webpack-plugin
  • CSS plugin npm install --save-dev style-loader css-loader
  • Live Server npm install --save-dev webpack-dev-server

For the Live Server npm start http://localhost:8080/

(back to top)

👥 Authors

👤 Author1

• GitHub: @Banzaman
• LinkedIn: Mark Rubanza Anderson

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

(back to top)

❓ FAQ (OPTIONAL)

• What is this for?

  • This is an app used to learn to send, receive data from an API, use API documentation, understand and use JSON and make JavaScript code asynchronous.

• Can i copy this project?

  • Your welcome, copy this project and let me know if you need something.

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