Microverse README Template

📗 Table of Contents

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

📖 Leaderboard

Leaderboard is a webapp that allows users to add their names and scores and view leaderboard for everyone who has added theirs

🛠 Built With

Tech Stack

Client

• Webpack

Server

• Webpack

Database

None.

Key Features

• [Add scores]
• [See leaderboard]

(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: Node LTS installed

Setup

Clone this repository to your desired folder using the below command:

  cd my-folder
  git clone git@github.com:flemton/leaderboard.git

Install

Install this project with:

  cd leaderboard
  npm i

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npx eslint .

👥 Author

👤 Author

• GitHub: @flemton
• Twitter: @oalhassan847
• LinkedIn: Alhassan Osman

(back to top)

🔭 Future Features

• [Get real scores from games]
• [add picture]

(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, considering giving it a star

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me this project to work on

(back to top)

📝 License

This project is MIT licensed.