README.md

Leaderboard Project

📗 Table of Contents

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

📖 Project Name

Leaderboard Project

🛠 Built With

• HTML, CSS, and JavaScript

Key Features

Describe between 1-3 key features of the application.

• Use of API to store scores of the players and to show the scores in the DOM.
• Project with webpack.
• Used HTML Webpack Plugin to generate HTML files.
• Array of leaders is used to populate the HTML.
• Function to iterate over tasks to populate HTML according to task index order.
• Dynamically generate leader list.
• Styling used a wireframe template.
• Code is created in src folder and dist folder is generated automatically.

(back to top)

🚀 Live Demo

Have a look the live demo of the website here.

(back to top)

💻 Getting Started

To clone the repository in local environment try following steps.

Prerequisites

• A web browser like Google Chrome.
• A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Node.js and npm for package installation.

$ node --version && npm --version

Setup

Clone the repository using this link

Install

In the terminal, go to your file directory and run this command.

$ git clone https://github.com/PrangonGhose/Leaderboard.git

Get into development

In the terminal, run these commands to get into development.

$ cd Leaderboard

$ npm init -y

$ npm install (install dependencies)

$ npm run build (create the optimized for production)

$ npm start (run the app locally)

Usage

This website is applicable for both mobile and desktop version.

Run tests

Deployment

(back to top)

👥 Authors

👤 Prangon Ghose

• GitHub: @PrangonGhose

(back to top)

🔭 Future Features

• Styling of the webpage
• Animation to add functionality
• Adding responsiveness

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• Code Reviewers
• Coding Partners

(back to top)

❓ FAQ

(back to top)

📝 License

This project is MIT licensed.