https://github.com/kensteph/leaderboard
Leaderboard is a project allows users to provide their score and display them in the leaderboard of the game. Build with HTML,CSS,JavaScript,API, and Webpack. This project uses Gitflow.
https://github.com/kensteph/leaderboard
api css gitflow-workflow html javascript webpack
Last synced: 3 months ago
JSON representation
Leaderboard is a project allows users to provide their score and display them in the leaderboard of the game. Build with HTML,CSS,JavaScript,API, and Webpack. This project uses Gitflow.
- Host: GitHub
- URL: https://github.com/kensteph/leaderboard
- Owner: kensteph
- License: mit
- Created: 2023-01-29T21:02:25.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-03-22T15:48:14.000Z (over 2 years ago)
- Last Synced: 2025-05-01T21:57:18.462Z (7 months ago)
- Topics: api, css, gitflow-workflow, html, javascript, webpack
- Language: JavaScript
- Homepage: https://leaderboard-kfp4.onrender.com/
- Size: 268 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Screenshots
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Leaderboard](#vgs-presentation)
- [💻 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)
- [📝 License](#license)
> Leaderboard is a project allows users to provide their score and display them in the leaderboard of the game. Build with HTML,CSS,JavaScript,API, and Webpack. This project uses Gitflow.
> This project uses the following stack :
Client
Server
> Here are some key features of the application :
- **Display leaderboard**
> Here you can visit my live demo :
- https://leaderboard-kfp4.onrender.com/
> Here you can see my presentation :
- [N/A]()
> Clone the repository by clicking on the 'Code' button and copy the link
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
You should have node install on your local machine
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
cd my-folder
git clone https://github.com/kensteph/leaderboard.git
```
-
### Install
Install dependencies :
npm i
### Usage
To run the project, execute the following command:
Open the index.html file in a web browser
### Run tests
To run tests, run the following command:
Example command:
To run the webhint linter
```sh
npx hint .
```
To run the stylehint linter
```sh
npx stylehint "**/*.{css,scss}"
```
To run the ESLint linter
```sh
npx eslint .
```
### Deployment
You can deploy this project using:
```sh
npm run build
```
```sh
npm run start
```
## 👥 Author
👤 **Kender Romain**
- GitHub: [@Kensteph](https://github.com/kensteph)
- Twitter: [@RomainKender](https://twitter.com/RomainKender)
- LinkedIn: [kender-romain8788](https://www.linkedin.com/in/kender-romain8788/)
- **Save the player's score**
- **Refresh the leaderboard**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project star it!
I would like to thank the Microverse team.
This project is [licensed](./LICENSE) .