Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/najibullahjafari/leaderboard

Leaderboard is a a web page that will save your score and your name online, It is developed by HTML, CSS, JavaScript, Git flow, API.
https://github.com/najibullahjafari/leaderboard

Last synced: 12 days ago
JSON representation

Leaderboard is a a web page that will save your score and your name online, It is developed by HTML, CSS, JavaScript, Git flow, API.

Awesome Lists containing this project

README

        




Leaderboard

# 📗 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](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 About the project

It is a library!

## 🛠 Built With

- HTML,
- CSS,
- Java Script
- GIT,
- GITHUB
- LINTERS
- Bootstrap
- Webpack
- ES6

### Tech Stack

Client

Server

### Key Features

- Linters for code quality
- DOM manipulation for dynamic content
- Responsive design for different screen sizes

In this project best coding practices is used.

## 🚀 Live Demo

[You can see the page live demo here](https://najiblearderboard.netlify.app/)

## 💻 Getting Started

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

1. Go to this URL link: https://github.com/najibullahjafari/leaderboard
2. clone the repo and start working on it.
3. try `npm install` to install dependencies.
4. to run the project use `npm run build` or `npm start` commends.

### Prerequisites

In order to run this project you need:

Google Chrome or other browser

```sh
https://www.google.com/chrome/?brand=JJTC&gclid=CjwKCAjw9J2iBhBPEiwAErwpeSDcMFWiIQWj2u5GY6owZ7OaOHw7dYYCHW7uTR4kvYosNJYd4wt4VxoCiywQAvD_BwE&gclsrc=aw.ds
```

Github Account:

```sh
https://github.com/
```

Npm installed:

```sh
https://nodejs.org/en/download
```

Git installed:

```sh
https://git-scm.com/downloads/
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/najibullahjafari/To-do-list
```

### Install

Install this project with:

Linters:

Lighthouse run:

```sh
npm install -g @lhci/[email protected]
```

Webhint run

```sh
npm install --save-dev [email protected]
```

StyleLint run:

```sh
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
```

### Usage

1. Go to this URL link: https://github.com/najibullahjafari/leaderboard
2. clone the repo and start working on it.
3. try `npm install` to install dependencies.
4. to run the project use `npm run build` or `npm start` commends.

### Run tests

To run tests, run the following command:

to check for styling errors:

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

### Deployment

You can deploy this project using:

Your working browser.

## 👥 Authors

👤 **Najibullah Jafari**

- GitHub: [Najibullah_jafari](https://github.com/najibullahjafari)
- Twitter: [Najibullah_jafari](https://twitter.com/Najib_Jafari_)
- LinkedIn: [Najibullah_jafari](https://www.linkedin.com/in/najibulla-jafari-609852263/)

👤 **Syeda Masuma Fatima**

(back to top)

## 🔭 Future Features

- **[Responsive Version]**

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

Do you like this project? So don't wait to give one star!

(back to top)

## 🙏 Acknowledgments

I thanks from Microverse!

(back to top)

## 📝 License

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

(back to top)