Skip to content

This is the seventh project for the second module in the Microverse program. It is a leaderboard list app fetched from an API and follows the GitFlow workflow.

License

Notifications You must be signed in to change notification settings

mahammad-mostafa/leader-board-list

Repository files navigation

🏷️ Leader Board List

This is the seventh project in the second module of the Microverse program.
Check the below contents for further details about this project.

📗 Contents

📖 Description

This project is a simple leaderboard list app with ES6 modules and bundled with WebPack. It consumes data from an external API and follows GitFlow workflow. Scores are loaded with asynchronous calls using async functions & promises. All project files are contained in src directory. Also config linters for (HTML / CSS3 / JavaScript) in the .github folder.

📌 Live Demo:

  • See the project live from here.

📌 Tech Stack:

  • Page strucutre is built with HTML5
  • Styling is built with CSS3
  • Dynamic content is built with JavaScript
  • Bundling is done with WebPack

📌 Key Features:

  • Responsive layout for all screens
  • Dark themed color palette
  • Inserts new player name & score
  • Automatic loading of players scores
  • List scrolling when height overflows

back to top

🛠️ Instructions

You can easily download or fork this repository and work on it immadiately!

📌 Prerequisites:

  • NodeJS for installing & running all packages

📌 Installation:

  • Install all dependencies with npm
npm install

📌 Development:

  • For live development on localhost:8080 run:
npm run start

📌 Deployment:

  • You can deploy this project by uploading files in the dist folder to a live server.
  • Create the distribution build using this command:
npm run build

back to top

👥 Authors

📌 Mahammad:

back to top

🔭 Future

Some additional features I may implement in the project:

  • Using CSS preprocessors and their relevant loaders
  • Implement two WebPack configurations for production & development

back to top

🤝🏻 Contributions

Wish to contribute to this project?
Contributions, issues, and feature requests are more than welcome!
Feel free to check the issues page too.

back to top

⭐️ Support

Like this project? Show your support by starring!

back to top

🙏🏻 Acknowledgements

I thank everyone at Microverse for guiding me through this project.

back to top

📝 License

This project is MIT licensed.

back to top