redmarverick/leaderboard

A Leaderboard of points that are updated dynamically using API

Leaderboard

📗 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
• 📝 License

📖 Leaderboard

Leaderboard is a project made to practice callbacks and promisses along with ES6 modules and webpack.

🛠 Built With

• HTML
• CSS
• JavaScript

Tech Stack

Client

• HTML
• CSS
• JavaScript

Key Features

• Use Webpack
• Use ES6
• Use Callbacks and Promisses

(back to top)

🚀 Live Demo

comming soon!

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

1. Web browser.
2. Code editor.
3. Git

Setup

Clone this repository to your desired folder and install required dependencies:

  cd my-folder
  git clone github.com/redmarverick/Leaderboard.git

  npm init -y
  npm install webpack webpack-cli --save-dev
  npm install --save-dev html-webpack-plugin
  npm install --save-dev html-loader 

  npm install --save-dev style-loader css-loader
  npm install --save-dev webpack-dev-server

Usage

To run the project, execute the following command:

  npm install webpack
  npm run production
  npm start

Run tests

To run tests, run the following command:

Comming soon.

(back to top)

👥 Authors

👤 Nylbert Victor

• GitHub: @Nylbert Victor
• Twitter: @Nylbert Victor
• LinkedIn: Nylbert Victor

(back to top)

🔭 Future Features

• [Implement the refresh button]
• [Implement the submit button]
• [Use Leaderboard API]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Thanks for checking out our books app! Please feel free to reach out with any questions or feedback, as your input is greatly appreciated. And if you enjoyed the project, don't forget to leave a star on the repo ⭐️.

(back to top)

🙏 Acknowledgments

would like to thanks Microverse corporation for the README template.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

leaderboard's Issues

Peer to peer Code Review

Hi @redmarverick !

You have done an excellent job and your code is looking good! 😃

• Your code is clean and organized!
• The JavaScript file looks really nice, It's very compressed and easy to understand, congrats! 🥂
• Great way to manage the API. 😎
• You can improve your code using best practices on the headings structure (h1, h2, h3) instead of h2, h5, h2. 👍

Keep it up and Happy coding!! 🎉🍾