https://github.com/tsheporamantso/leaderboard
In this activity I set up a JavaScript project for the leaderboard list app, using webpack and ES6 features.
https://github.com/tsheporamantso/leaderboard
api api-rest css3 gitflow-workflow html5 javascript webpack
Last synced: 9 months ago
JSON representation
In this activity I set up a JavaScript project for the leaderboard list app, using webpack and ES6 features.
- Host: GitHub
- URL: https://github.com/tsheporamantso/leaderboard
- Owner: tsheporamantso
- License: mit
- Created: 2023-04-11T08:18:16.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-04-12T14:30:36.000Z (over 2 years ago)
- Last Synced: 2025-01-19T23:34:11.152Z (10 months ago)
- Topics: api, api-rest, css3, gitflow-workflow, html5, javascript, webpack
- Language: JavaScript
- Homepage: https://tsheporamantso.github.io/Leaderboard/dist
- Size: 291 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Gladwin Tshepo Ramantso
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)
- [📝 License](#license)
This project is an online score board that allow user to add and display score(s).
**LeaderBoard** In this project, I built a digital leader-board that enable the user to add and tracks current and previously added scores
- HTML
- CSS
- JavaScript(ES6)
- Webpack
Version Control
Visual Studio Code
Node js
- **JavaScript Webpack**
- **Basic UI with plain HTML**
- [Live Demo]( https://tsheporamantso.github.io/Leaderboard/dist)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Visual Studio Code.
- Node JS.
- Git bash.
- GitHub Account.
Example command:
```sh
gem node js
```
### Setup
Clone this repository to your desired folder:
Use git clone command or download ZIP folder
Example commands:
```sh
cd my-folder
git clone git@github.com:tsheporamantso/Leaderboard.git
```
### Install
Install this project with:
npm
Example command:
```sh
cd my-project
npm init -y
```
### Usage
To run the project, execute the following command:
npm start or live server
Example command:
```sh
GitHub Pages Server
```
### Run tests
To run tests, run the following command:
npm test
Example command:
```sh
npx stylelint "**/*.{css,scss}"
```
```sh
npx eslint .
```
```sh
npm start
```
```sh
npm run dev
```
### Deployment
You can deploy this project using:
GitHub Pages
Example:
```sh
https://tsheporamantso.github.io/Leaderboard/dist
```
👤 **Gladwin Tshepo Ramantso**
- GitHub: [@tsheporamantso](https://github.com/tsheporamantso)
- Twitter: [@ramgt001](https://twitter.com/ramgt001)
- LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/)
- [ ] **Add more styling**
- [ ] **Send and receive data from API**
- [ ] **Final touches**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/tsheporamantso/Leaderboard/issues).
If you like this project please follow me on github & twitter and also connect on Linkedin.
I would like to thank Microverse for this exercise.
This project is [MIT](./LICENSE) licensed.