README.md

Leaderboard

📗 Table of Contents

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

📖 Description.

Leaderboard website for displaying and submitting player scores. Connects to Leaderboard API for 'Refresh' and 'Submit' actions. Utilizes Gitflow for version control. Priority on preserving user input and adding styling."

🛠 Built With HTML, CSS and JavaScript

Tech Stack

• HTML
• CSS
• JavaScript

Key Features

Some of the key features:

• Set up app using webpack.
• Update the leaderboard using an API.
• Use of Git Flow
• Linters Setup

(back to top)

💻 Live Demo

🚀Live Demo

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps:

• Open your Terminal in your VSCode.
• Navigate to the desired directory [folder] to which you want to clone the repository to
• [Copy & Paste] the Git clone you find in the code button https://github.com/the-faizmohammad/leaderboard-game into your terminal and press [Enter]
• run using "npm run dev" in your terminal

Prerequisites

In order to run this project you need:

• General Understanding of HTML, CSS and JavaScript
• basic Knowledge of Git Commands
• basic Knowledge of the Terminal Commands
• basic understanding of gitflow
• understanding Es6 javascript module
• webpack configuration

Setup

Clone this repository to your desired folder:

• git clone (https://github.com/the-faizmohammad/leaderboard-game)

Example commands:

  cd my-folder
  git (https://github.com/the-faizmohammad/leaderboard-game)

--->

Install

Must-Install-Project-with-the-Following-Programmes:

• Git
• Node.js
• npm install

(back to top)

👥 Authors

👤 Faiz Mohammad

• GitHub: @githubhandle
• Twitter: @gmail
• LinkedIn: LinkedIn

🔭 Future Features

• Adding more styling to CSS
• Adding more functionality to the app

(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 don't hesitate to support me with your valued contribution and don't forget to star the repo to reach more people.

(back to top)

🙏 Acknowledgments

I would like to thank...

• Microverse code reviewer.
• My Coding Partners & contributors.
• Microverse Community in Slack

(back to top)

❓ FAQ

Can I clone this project?**

• Yes, but please give star and follow me on github.

Can I contribute to this project?**

• Yes, just create new feature branch.

(back to top)

📝 License

This project is MIT licensed.

(back to top)