📗 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
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Leaderboard Template App]

Leaderboard Template App is a lightweight Leaderboard Temp App using ES6, ESM and webpack.

(back to top)

🛠 Built With

Tech Stack

Key Features

• Dinamically generate DOM
• Webpack Implementation
• Wireframe
• Add API interactivity

🚀 Live Demo

You can find a live demo in HERE.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps. To run local server or to make any modifications to the project NPM and Node.js must be installed.

Prerequisites

In order to run this project you need: To clone or fork and run it in a browser

Setup

Clone this repository to your desired folder:

For example, using Ubuntu:

  cd my-desired-folder
  git clone git@github.com:lordksix/leaderboard-template.git

For more information on how to clone or fork a repository:

• How to clone a repo
• How to fork a repo

If you want to make any kind of change or modification, Node.Js and NPM is necesary. For more information on how to install node.js and npm:

• Downloading and installing Node.js and npm

Install

To install dependencies, the following command must be run in the terminal:

  cd leaderboard-template
  npm install

Usage

To run the app, open with index.html with any web browser.

For example, for Google Chrome with Ubuntu:

  cd build
  google-chrome index.html

Or, if you have setup NPM and Node.js, you have run a localhost using the following command:

  npm run start

Run tests

There are no test available for this project.

Deployment

To deploy this project, use any web hosting service. Files to be used in deployment are:

• all files in build folder

This project is deployed using GitHub Pages.

Go to 🚀 Live Demo to check it out.

(back to top)

👥 Authors

👤 Author

• GitHub: @lordksix
• Twitter: @wapasquel

(back to top)

🔭 Future Features

Future changes:

• TBA

(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, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.

(back to top)

🙏 Acknowledgments

(back to top)

❓ FAQ

• Do I need a IDE or a special text editor to make changes?

  • No, you don't. You can use NotePad to make changes.

(back to top)

📝 License

This project is MIT licensed.

(back to top)