Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ab-noori/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.
https://github.com/ab-noori/leaderboard

html5 medium-fidelity-wireframe modules rest-api scss vanilla-javascript webpack5

Last synced: 2 months ago
JSON representation

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.

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/Microverse-blueviolet)

> # Leaderboard
### Desktop view shoots for this project:

| Desktop Veiw Representation|
|---------------------------------------|
|

![screenshot](./src/assets/desktop-shot.PNG)
|
|
![screenshot](./src/assets/mobile-shot.PNG)
|

# 📗 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)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 [Leaderboard]

> **[Leaderboard]** is 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



- Server

### Key Features

- **[Responsive layout]**
- **[UX/UI accessibility]**
- **[Dynamic data]**

(back to top)

## 🚀 Live Demo

> - [Live Demo Link](https://ab-noori.github.io/Leaderboard/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:
- A browser of you choice.
- A text editor of your choice.
- An installed node.js on your local system

### Setup

Clone this repository to your desired folder:

- Use the following Commands:

cd your-desired-folder
git clone [email protected]:ab-noori/Leaderboard.git

### Install

Install this project with:

- You can deploy this projec on hosting provider of your choise or you can deploy it on github pages.

### Usage
- Use following commands to run on your local system:

npm run build
npm run dev

### Run tests
- Run the following script and style test:

npx eslint .
npx stylelint "**/*.{css,scss}"

### Deployment

You can deploy this project using:
- Free deployment services like GitHub pages.
- Any deployment services of your choice.

(back to top)

## 👥 Authors

👤 **Abdul Ali Noori**

- GitHub: [@ab-noori](https://github.com/ab-noori)
- Twitter: [@AbdulAliNoori4](https://twitter.com/AbdulAliNoori4)
- LinkedIn: [abdul-ali-noori](https://www.linkedin.com/in/abdul-ali-noori-384b85195/)

## 🔭 Future Features

- [ ] **[Add About page]**
- [ ] **[Add Contact page]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ab-noori/Awesome-Books/issues).

(back to top)

## ⭐️ Show your support


If you like this project, give it a star.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse and my coding partners, and also give credit to Traversy Media
YouTub Channel, I really learned a lot from this channel.

(back to top)

## ❓ FAQ (OPTIONAL)

- **How to make it mobile friendly?**

- Put a viewport tag in the header

- **How to design the site?**

- Draw a mockup before start to code

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)