Wire Frame

Leaderboard

📗 Table of Contents

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

📖 Leaderboard

This is a simple leaderbord web application that allows users to add, edit, and delete users.

🛠 Built With

• The app is built using HTML, CSS, JavaScript, POST API and runs on WebApp.

Tech Stack

Teck-stack

• Client: HTML, CSS, JavaScript
• Server: Webpack, gh-pages
• Database: Not applicable

(back to top)

Key Features

• Create a game ID
• Add name and score
• Display name and score from API

(back to top)

💻 Getting Started

To get a local copy of the project up and running, follow these steps.

Prerequisites

In order to run this project, you need to have a web browser installed on your computer.

Setup

Clone this repository to your desired folder by running the following command:

  clone git@github.com:yordinia/Leaderboard.git

Install

Run npm install to install all dependencies

  cd Leaderboard
  npm install

Usage

Run npm start to start the application using webapp live server.

  npm start

This will open the app in your browser at http://localhost:8081/

Run tests

To run tests for the Leaderboard, follow these steps:

• Open the command prompt or terminal on your computer.
• Navigate to the project directory using the cd command.
• Type the command npm run test and press enter.

 npm run test

Deployment

> LINK

(back to top)

👥 Author

This project was developed by:

👤 ** Yordanos Temesgen **

• GitHub: @yordinia
• Twitter: @yordinia
• LinkedIn: @yordinia

(back to top)

🔭 Future Features

• Clearing the scores
• Editing name / scores
• Sorting / dragging

(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 give it a star on GitHub.

(back to top)

🙏 Acknowledgments

I would like to thank the following resources and individuals for their help and inspiration:

• Microverse, an online software engineering coding bootcamp.

(back to top)

❓ FAQ (OPTIONAL)

• Can I modify and redistribute this project?

  • Yes, you can modify and redistribute this project as long as you follow the terms of the MIT license.

• How can I contribute to this project?

  • Contributions, issues, and feature requests are welcome! You can check the issues page to see if there are any current issues or feature requests that you can work on. If not, feel free to submit a new issue or pull request. Before contributing, please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)