https://github.com/adamilare/leaderboard
LEADERBOARD is part of introductory projects in Microverse software development program. The project implementation introduces developers to async/callback/promise calls.
https://github.com/adamilare/leaderboard
css html javascript webpack
Last synced: 3 months ago
JSON representation
LEADERBOARD is part of introductory projects in Microverse software development program. The project implementation introduces developers to async/callback/promise calls.
- Host: GitHub
- URL: https://github.com/adamilare/leaderboard
- Owner: adamilare
- License: mit
- Created: 2023-03-08T06:27:34.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-03-10T07:31:49.000Z (over 3 years ago)
- Last Synced: 2025-02-04T11:05:23.950Z (over 1 year ago)
- Topics: css, html, javascript, webpack
- Language: JavaScript
- Homepage: https://adamilare.github.io/leaderboard/
- Size: 218 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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)
- [🚀 Live Demo](#live-demo)
- [💻 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** is part of introductory projects in Microverse software development program.
The project implementation introduces developers to async/callback/promise calls.
- HTML
- CSS
- Javascript
Client
Server
Database
- **Built with Webpack development environment**
- **Basic Leaderboard operations ;**
- Add new score,
- List added items,
- Refresh leaderboard
- **Starting project development from a template repo**
- [Live Demo](https://adamilare.github.io/leaderboard/dist)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need Webpack deveopment environment installed for this on you local machine
### Setup
Clone this repository to your desired folder on your local machine
### Install
The projects incorporate some linters check, to get them running on your local system follow these below;
1. `.github/workflows/linters.yml` is already included in project, this is used by Github to run tests on the repo.
2. To install Webpack packages and dependencies
- `npm init -y` initalize the project.
- `npm i` installs all dependencies listed in the projects's package.json
- `npm install webpack webpack-cli --save-dev` installs webpack
- `npm install --save-dev html-webpack-plugin` installs webpack plugin
- `npm install --save-dev style-loader css-loader` installs assets loaders
- `npm install --save-dev webpack-dev-server` installs webpack server
3. To install Stylelint linters run:
- `npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x`
- `npx stylelint "\*_/_.{css,scss}" --fix" to run the test.
4. To Install ESLint run:
- `npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x`
- `npx eslint . --fix` to run the test
5. To install Webhint linters run:
- `npm install --save-dev hint@7.x`
- `npx hint .` to run the test.
### Usage
To run the project, clone the repository to your local machine, install dependencies and launch through webpack Server on VScode
### Run tests
Follow the procedures under [Install](#install) to run some of the included linter tests.
### Deployment
You can deploy this project using:
- [Github Page](https://pages.github.com)
👤 **Damilare Adepoju**
- GitHub: [@githubhandle](https://github.com/adamilare)
- Twitter: [@twitterhandle](https://twitter.com/mailtodare)
- LinkedIn: [LinkedIn](https://linkedin.com/in/adamilare)
- GitUp Page: [My Page](https://adamilare.github.io/)
- N/A
Contributions, issues, and feature requests are welcomed!
Feel free to check the [issues page](https://github.com/adamilare/leaderboard/issues).
If you like this project please give it a thumb up.
I would like to thank Microverse Inc. for providing template and other guidelines for this project.
N/A
This project is [MIT](./LICENSE) licensed.