https://github.com/mmggyy66/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/mmggyy66/leaderboard
bootstrap5 css3 html5 javascript webpack5
Last synced: 4 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/mmggyy66/leaderboard
- Owner: MMGGYY66
- License: mit
- Created: 2023-01-28T04:03:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-15T23:52:37.000Z (over 3 years ago)
- Last Synced: 2025-03-30T11:23:04.021Z (over 1 year ago)
- Topics: bootstrap5, css3, html5, javascript, webpack5
- Language: JavaScript
- Homepage: https://mmggyy66.github.io/leaderboard/
- Size: 478 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# leaderboard
My Microverse leaderboard
project (Module two)
# π Table of Contents
- [π [π― leaderboard](#leaderboard)
- [π Built With](#-built-with-)
- [Tech Stack](#tech-stack-)
- [π Live Demo](#-live-demo-)
- [π Presentation](#-presentation-)
- [Deploy my website with github pages":](#deploy-my-website-with-github-pages)
- [- Loom video link:](#-loom-video-link)
- [π» Getting Started](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Requirements](#requirements)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [π₯ Authors](#-authors-)
- [π Future Features](#-future-features-)
- [π€ Contributing](#-contributing-)
- [π Show your support](#show-your-support)
- [πAcknowledgments](#acknowledgments-)
- [π License](#license)
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.
Technology
- HTML
- CSS
- Bootstrap 5
- Javascript
- Webpack
- Linters (Lighthouse, Webhint, Stylelint, Eslint)
- Git/GitHub work-flow
Client
Server
Database
- [leaderboard](https://mmggyy66.github.io/leaderboard/)
- []()
## Deploy my website with github pages"
## [leaderboard](https://mmggyy66.github.io/leaderboard/)
## - Loom video link
[]()
To get a local copy up and running follow these simple example steps.
### Prerequisites
- IDE to edit and run the code (We use Visual Studio Code π₯).
- Git to versionning your work.
### Install
- first install package.json and node_modules run:
npm init -y
- npm install --save-dev hint
- npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
- npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x
## Requirements
- Linters configuration.
Clone the repository to get start with project, then make sure to install dependencies in the linters file located in the [linter](https://github.com/Bateyjosue/linters-html-css/blob/main/.github/workflows/linters.yml) file
### Run tests
Check for the tests when you generate a pull request and fix the errors if any.
For stylelint error run:
sudo npx stylelint "\*_/_.{css,scss}" --fix
and it will the fix style issues automatically.
- to test and check the html file/s is error-free run:
npx hint .
- to fix errors run:
npx hint . -f
- to test and check the css file/s is error-free run:
npx stylelint "**/*.{css,scss}"
- to fix errors run:
npx stylelint "**/*.{css,scss}" --fix
- to test and check the js file/s is error-free run:
npx eslint .
- to fix errors run:
npx eslint . --fix
### Deployment
π€ **Mohamed Gamil Eldimardash**
- GitHub: [@github](https://github.com/MMGGYY66)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mohamed-eldimardash-0023a3b5/)
- Twitter: [twitter](https://twitter.com/MOHAMEDELDIMARd)
- Facebook: [facebook](https://www.facebook.com/MOHAMED.ELDIMARDASH/)
- [ ] Project 2: send and receive data from API.
- [ ] Project 3: final touches.
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page
Give a βοΈ if you like this project!
- [Microverse Team](https://www.microverse.org/).
I would like to thank Microverse for the information provided to build this project.
- **Can I use the project for any purpose?**
- Yes, you can use this files for anything you need.
- **Is the information saved in any database?**
- No, all data is saved in Local Storage.
This project is [MIT](https://github.com/MMGGYY66/readme-template/blob/master/MIT.md) licensed.