Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mohamedhnoor/leaderboard-app

leaderboard-App is a 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.
https://github.com/mohamedhnoor/leaderboard-app

css3 gitflow html5 javascript website

Last synced: about 4 hours ago
JSON representation

leaderboard-App is a 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.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 leaderboard-App

**leaderboard-App** is a 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

- Html
- Css
- Js
- Webpack

### Tech Stack

> Describe the tech stack and include only the relevant sections that apply to your project.

Client

### Key Features

- **[Project 1: basic page structure.]**
- **[Project 2: send and receive data from API.]**
- **[Project 3: final touches]**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://mohamedhnoor.github.io/Leaderboard-App/dist/)

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

- Open your terminal or command line

### Setup

Clone this repository to your desired folder:

- Run `git clone` and Paste the link
- After the clone, type in the command `cd LeaderBoard` to access the directory on the terminal

### Install

Install this project with:

- run `npm install`.

### Usage

To run the project, execute the following command:

- Run `npm run dev` and it will load a live server in http://localhost:8080/

### Deployment

You can deploy this project using:

- Run `npm run build` and it will build and optimized files for production mood

(back to top)

## 👥 Authors

👤 **Mohamed H Noor**

- GitHub: [@MohamedHNoor](https://github.com/MohamedHNoor)
- Twitter: [@MohamedHNoor](https://twitter.com/MohamedHNoor)
- LinkedIn: [@MohamedHNoor](https://www.linkedin.com/in/mohamedhnoor/)

(back to top)

## 🔭 Future Features

- [ ] **basic page structure**
- [ ] **send and receive data from API.**
- [ ] **final touches.**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/MohamedHNoor/Leaderboard-App/issues).

(back to top)

## ⭐️ Show your support

If you like this project please give it an star. Thank you!

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for giving me this project to improve my skills.

(back to top)

## 📝 License

This project is [MIT](MIT.md) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)