https://github.com/sonickmumba/leaderboard

The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.
https://github.com/sonickmumba/leaderboard

api css es6 gitflow html javascript webpack

Last synced: 23 days ago
JSON representation

The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.

• Host: GitHub
• URL: https://github.com/sonickmumba/leaderboard
• Owner: Sonickmumba
• Created: 2022-09-05T15:00:55.000Z (over 2 years ago)
• Default Branch: development
• Last Pushed: 2023-05-11T02:38:10.000Z (over 1 year ago)
• Last Synced: 2024-10-31T02:41:55.259Z (2 months ago)
• Topics: api, css, es6, gitflow, html, javascript, webpack
• Language: JavaScript
• Homepage:
• Size: 305 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](https://img.shields.io/badge/Microverse-blueviolet)

# Leaderboard

> The leaderboard website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.

## Website Mockup 📱 💻 🖥️

![desktop](https://user-images.githubusercontent.com/106140591/189118433-f54bcecc-e764-4f26-9118-72c5d82b44e4.png)

![mobile-version](https://user-images.githubusercontent.com/106140591/189119383-90473585-9296-40ad-8533-83854cec9f37.png)

## Built With

- HTML and CSS

- Frameworks: N/A

- Technologies used: GIT, GITHUB, LINTERS

- npm

- Webpack

- gitflow

- ES6

## Live Demo

Check **Live Demo** [Leaderboard.](https://sonickmumba.github.io/Leaderboard/)

## Getting Started

> To get a local copy up and running follow these simple example steps.

### Prerequisites

- npm (node package manager) – to be able to install packages locally.

- A github Account – to be able to use github actions.

### Setup

Use 'git clone [email protected]:Sonickmumba/Leaderboard.git' to clone the repository to your local environment and begin working on it.

- run **'npm init'** to install dependancy packages.

- run **'npm run build'** to build the project and to generate dist files.

- run **'npm start'** to run you project in development mode.

### Usage

- Run npm start

### Run tests

- run Webhint linter

    - Run npx hint . on the root of your directory of your project.

- run Stylelint linter

    - Run npx stylelint "**/*.{css,scss}" on the root of your directory of your project.

- run ESLint linter

    - Run npx eslint . on the root of your directory of your project.

### Deployment

To run the project open the downloaded folder (after extraction) then run the "**index.html**" file in your browser.

## Authors

👤 **Author1**

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

- Twitter: [@Sonick](https://twitter.com/MumbaSonick)

- LinkedIn: [Sonick Mumba](https://www.linkedin.com/in/sonick-m-301557a2/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

## Acknowledgement

## Show your support

Give a ⭐️ if you like this project!

## 📝 License

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