https://github.com/tylher/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/tylher/leaderboard
Last synced: 2 months 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/tylher/leaderboard
- Owner: tylher
- Created: 2022-04-05T10:50:18.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-04-09T12:20:34.000Z (about 3 years ago)
- Last Synced: 2025-02-03T09:24:08.387Z (4 months ago)
- Language: JavaScript
- Size: 326 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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.
## Built With
- HTML, CSS , JavaScript
- Webpack, Babel
## Live Demo (if available)
[Live Demo Link](https://tylher.github.io/LeaderBoard/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Basic Knowledge of HTML and CSS
- Basic knowledge of JavaScript ES6 syntax
- Web browser of your choice
- Integrated development environment (IDE) of your choice (preferrably VScode).
### Setup
[install git here](https://git-scm.com/downloads)
Clone the project using the command below in your command line interface (CLI)
```
git clone [email protected]:tylher/LeaderBoard.git
```
### Install
Make sure you have node and npm installed on your PC use `node -v` and `npm -v` on your CLI to check.
[install node here](https://nodejs.org/en/download/) if you have not.
To install the packages for this project run:
```
npm install
```
### Usage
To build a bundled version of project, run
```
npm run build
```
To run local server, type:
```
npm start
```
### Run tests
Run the following commands to catch errors in source codes:
- For html files, `npx hint .`
- For css or scss files, `npx stylelint "**/*.{css,scss}"`
- For Javascript files, `npx eslint .`
To automatically fix some errors, run the following:
- For css or scss files, `npx stylelint --fix "**/*.{css,scss}"`
- For Javascript files, `npx eslint --fix .`
### Deployment
This project was deployed using githib pages. [Learn more](https://docs.github.com/en/pages/quickstart)
## Authors
👤 **Author1**
- GitHub: [@tylher](https://github.com/tylher)
- Twitter: [@damolaDev](https://twitter.com/Damoladev)
- LinkedIn: [Taiwo Adediran](https://www.linkedin.com/in/taiwo-adediran-327654127/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc
## 📝 License
This project is [MIT](./MIT.md) licensed.