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

https://github.com/alibaba2023/leaderboard

A simple project that lists names and scores with the help of API.
https://github.com/alibaba2023/leaderboard

api css3 html5 javascript linters webpack

Last synced: 9 months ago
JSON representation

A simple project that lists names and scores with the help of API.

Awesome Lists containing this project

README

          



Leaderboard

# 📗 Table of Contents

- [ 📗 Table of Contents ](#-table-of-contents)
- [ 📖 Leaderboard ](#-Leaderboard-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Leaderboard

**Leaderboard** is a JavaScript project that allows users to add and remove scores.

## 🛠 Built With

1. ✅ **HTML**
2. ✅ **CSS**
3. ✅ **JavaScript**
4. ✅ **Webpack**
5. ✅ **LightHouse**
6. ✅ **WebHint**
7. ✅ **Styelint**
8. ✅ **ESLint**
9. ✅ **Git**
10. ✅ **Git flow**
11. ✅ **Github**

### Key Features

- **Main page**
- **Responsive**
- **Good look and feel**

(back to top)

## 🚀 Live Demo

- ✅ For seeing the live dome [click here](https://alibaba2023.github.io/Leaderboard/dist/)

(back to top)

## 💻 Getting Started

**To get a local copy up and running, follow these steps.**

1. Download or clone this [repostory](https://github.com/Alibaba2023/Leaderboard).
2. Provide a browser.
3. Open the `index.html` file using the webpage browser.

### Prerequisites

**In order to run this project you need:**

- ✔ [Git](https://git-scm.com/downloads) installed in your machine.
- ✔ Sign in or sign up to your [Github](https://github.com/) account.
- ✔ A professional editor such as [VS Code](https://code.visualstudio.com/download).
- ✔ An Updated web browser such as Google Chrome, you can download it from [here](https://www.google.com/chrome/).
- ✔ [Node.js](https://nodejs.org/en/download) installed in your machine.
- ✔ Lighthouse.
- ✔ Webhint

### Setup

- Clone this [repository](https://github.com/Alibaba2023/Leaderboard) to your desired folder:

- Example commands:

```sh
cd < YOUR-FOLDER >
git clone https://github.com/Alibaba2023/Leaderboard
```

### Install

- To install this project run the commands below


```sh
npm install
npm run build
npm start
```

### Usage

- To run the project, execute the following command:

```sh
cd < YOUR FOLDER >
git clone https://github.com/Alibaba2023/Leaderboard
```

### Run tests

1. WebHint ☑

```
npx hint .
```

2. Stylelint ☑

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

3. ESLint ☑

```
npx eslint .
```

### Deployment

**This project is deployed by the author, no permission for deployment by any other client.**

(back to top)

## 👥 Authors

👤 **Ali Baba Hussaini (Main Author)**

- GitHub: [@Alibaba2023](https://github.com/Alibaba2023)
- Twitter: [@AliBabaHu2023](https://twitter.com/AliBabaHu2023)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ali-baba-hussaini-630607267/)

(back to top)

## 🔭 Future Features

- [ ] **Client interaction**
- [ ] **Deploy to a universal server**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project, kindly drop a start for the [repository](https://github.com/Alibaba2023/Leaderboard);

(back to top)

## 🙏 Acknowledgments

I would like to thank [Microverse](https://www.microverse.org/?grsf=mohammad-a-nbtazu) for providing the opportunity for this project to be done And my family for thier support.

(back to top)

## 📝 License

This project is [LICENSES](LICENSE.md) licensed.

(back to top)