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

https://github.com/mahabubx7/leaderboard

Leader-board is a web-application for the standings for a particular game. Users can add, get scores in here.
https://github.com/mahabubx7/leaderboard

es6 javascript json-api scss webpack

Last synced: 4 months ago
JSON representation

Leader-board is a web-application for the standings for a particular game. Users can add, get scores in here.

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)
- [💻 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]

Leader-board is a web-application for the standings for a particular game. Users can add, get scores in here.

## 🛠 Built With `HTML/CSS`,`Nodejs/JavaScript`, and `Webpack`

### Tech Stack `HTML/CSS` with `JavaScript` & `Webpack`

Client

### Key Features

- **[Clean and Simple Static Webpages]**
- **[Only Raw HTML & CSS with Js]**
- **[Nodejs for development]**
- **[Webpack for static bundler]**

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

Check Git is already installed and working:

```sh
git --version
node --version
```

It should not show you any error. And should return the version info.

### Setup

Clone this repository to your desired folder:

Execute this:

```sh
git clone [email protected]:mahabubx7/leaderboard.git
```

### Install

Install this project with:

Install Dependencies:

```sh
cd your-project-folder
npm install
```

### Usage

To run the project, execute the following command:

Execute this:

```sh
npm start
```

### Run tests

To run tests, run the following command:

Testing with Lint-checks:

```sh
npm test
```

### Deployment

Deployed in `Github Pages`. [Live Preview](https://mahabubx7.github.io/leaderboard/)

(back to top)

## 👥 Authors

👤 **Mahabub**

- GitHub: [@mahabubx7](https://github.com/mahabubx7)
- Twitter: [@mahabub\_\_7](https://twitter.com/mahabub__7)
- LinkedIn: [LinkedIn](https://linkedin.com/in/mahabubx7)

(back to top)

## 🔭 Future Features

- [ ] **[Dynamic Renders]**
- [ ] **[Form functionalities]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project... please give it a start.

(back to top)

## 🙏 Acknowledgments

I would like to thank... microverse team.

(back to top)

## ❓ FAQ (OPTIONAL)

- **[Why Webpack?]**

- [It is a static bundler. It helps us to bundle a big and massy web-pages project into a bundled and gives us optimized performance. ]

(back to top)

## 📝 License

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

(back to top)