Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/adeola003/leaderboard

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/adeola003/leaderboard
Owner: adeola003
License: mit
Created: 2023-04-12T08:14:47.000Z (almost 2 years ago)
Default Branch: development
Last Pushed: 2023-04-14T17:00:15.000Z (almost 2 years ago)
Last Synced: 2024-11-11T03:52:08.325Z (3 months ago)
Language: JavaScript
Size: 1.07 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.md

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](#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]** This project is basic website that allows users to add scores from different users, built using HTML, CSS, Javascript and the webpack technology.

## 🛠 Built With 

### Tech Stack 

  Client

  


    "HTML"

    "CSS"

    "script.Javascript"

  


### Key Features 

- [x] Create a collection that keeps a list of tasks

- [x] Display all tasks saved in the collection in the top part of the page.

- [x] Used webpack technology.

(back to top)


## 🚀 Live Demo 

- [Comming soon](#)

(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 terminal on the same folder of the project and run:

```sh

 npm install

```

### Setup

Clone this repository to your desired folder:

```sh

  git https://github.com/adeola003/Leaderboard.git

  cd Leaderboard

```

### Install

Install this project with:

```sh

  npm install

```

### Usage

```

1. download the project from clone

2. open live server for the project

3. You can see it in the browser

```

### Build for production

```

npm run build

```

### Run tests

- ### Linter Tests

To run tests, run the following command:

To check for html errors run:

```sh

  npx hint .

```

To check for css errors run:

```sh

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

```

To check for js errors run:

```sh

  npx eslint .

```

(back to top)


## 👥 Authors 

👤 **Abdel-Khafid SALAOU**

- GitHub: [@githubhandle](https://github.com/adeola003)

- Twitter: [@twitterhandle](https://twitter.com/khadaf6)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/abdel-khafid-salaou-a18396161)

(back to top)


## 🔭 Future Features 

- [x] Add test to the project using jest

- [x] Add the live demo for the project

- [x] Add new some features to the project

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this feel free to follow me on github and give this project a star..

(back to top)


## 🙏 Acknowledgments 

- Thanks to the Microverse team for the great curriculum.

- Thanks to the Code Reviewer(s) for the insightful feedbacks.

- Hat tip to anyone whose code was used.

(back to top)


(back to top)


## 📝 License 

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

(back to top)