📗 Table of Contents

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

📖 Leaderboard

The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JAVASCRIPT

Server

• N/A

Database

• N/A

Key Features

• Follow a correct Gitflow
• Comply with linters
• DOM events with Javascript
• Javascript events
• Use objects to store and access data
• Use proper ES6 syntax
• Use npm as software packages system
• Use webpack to bundle JavaScript
• Send and receive data from an API
• Use API documentation
• Understand and use JSON
• Make JavaScript code asynchronous

(back to top)

🚀 Live Demo

• Live Demo Link

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

✅ Github account
✅ Visual Studio Code installed
✅ Node.js installed
✅ Git Bash installed (optional)

Setup

Clone this repository to your desired folder:

  cd [my-folder]
  git clone "putHereRepoLink"

Install

Use this command to initiliaze all packages:

  npm install

Usage

Use this command to open the web server:

  npm start

(back to top)

👥 Author

Carlos Igreda

• GitHub: @CarlosIgreda
• Twitter: @carlosigreda
• LinkedIn: carlos-jesús-igreda-rivas-323763116

(back to top)

🔭 Future Features

• Use js frameworks

(back to top)

🤝 Contributing

👤 Collaboration:

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 you can follow me on Github.

(back to top)

🙏 Acknowledgments

I would like to thank all Microverse staff and my coding partners as well.

(back to top)

❓ FAQ

• What is a Linter?

  • Linter is a tool that analyzes source code to flag programming errors, bugs, stylistic errors, and suspicious constructs.

• What is meant by Gitflow?

  • Gitflow is an alternative Git branching model that involves the use of feature branches and multiple primary branches.

• What is DOM?

  • The Document Object Model (DOM) is the data representation of the objects that comprise the structure and content of a document on the web.

(back to top)

📝 License

This project is MIT licensed.

(back to top)