Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peteugwu/leaderboard-app
A JavaScript project for a simple Leaderboard list app. It allows a user to add score and name, and display it on board-like form.
https://github.com/peteugwu/leaderboard-app
css html javascript
Last synced: 2 months ago
JSON representation
A JavaScript project for a simple Leaderboard list app. It allows a user to add score and name, and display it on board-like form.
- Host: GitHub
- URL: https://github.com/peteugwu/leaderboard-app
- Owner: PeteUgwu
- Created: 2022-11-26T16:28:52.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-27T20:49:56.000Z (almost 2 years ago)
- Last Synced: 2024-10-03T13:22:07.087Z (3 months ago)
- Topics: css, html, javascript
- Language: JavaScript
- Homepage: https://peteugwu.github.io/Leaderboard-app/dist
- Size: 476 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Microverse README Template
# 📗 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](#faq)
- [📝 License](#license)
# 📖 [Leaderboard Project] A JavaScript project for a simple Leaderboard list app. It allows a user to add score and name, and display it on board-like form
> Learning objectives for this project was to create a leaderboard,
and with an api that stores, score inputs
**[Leaderboard Project]** is a live scoreboard/Leaderboard api
## 🛠 Built With
- HTML
- CSS
- Javascript (ES6)
> The tech stack, used in this project is as follows:
- HTML
- CSS
- JavaScript
- API's
- Webpack
> 1-3 key features of the application.
- **[load/display scores from the api]**
- **[add scores to the api]**
- **[button functionality and input field required]**
- [Live Demo Link](https://peteugwu.github.io/Leaderboard-app/dist/)
> To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Have a local version control like Git. Which is a open source distributed version control system designed for source code management
- A text editor (e.g Visual Studio Code, Vim, Atom & Sublime.)
- A web browser (e.g Chrome, Safari, Mozilla Firefox.)
- Live Server which is a web extension that helps you to live reload feature for dynamic content (PHP, Node.js, ASPNET)
- Download waves to check project accessibilty
### Setup
Clone this repository to your desired folder:
To get a local copy up and running follow these simple example steps.
- npm
```sh
npm install npm@latest -g
```
### Install
Install this project with:
1. Clone the repo by running the command
```sh
git clone https://github.com/PeteUgwu/Leaderboard-app
```
2. Open the directory of the project
```sh
cd set-up
```
3. Open the directory of the src
```sh
cd src
```
4. Open the html file
```sh
Click and open the html file
```
5. Please install the node module by running this command on the terminal
```sh
npm install
```
6. Please run the following to render on the browser
```sh
npm start
```
### Usage
To run the project, execute the following command:
1. Please run the following to render on the browser
```sh
npm start
```
👤 **Peter**
- GitHub: [@PeteUgwu](https://github.com/PeteUgwu)
- Twitter: [@Petrus4Charles](https://twitter.com/Petrus4Charles)
- LinkedIn: [/peteugwu/](https://www.linkedin.com/in/peteugwu/)
> Describe 1 - 3 features you will add to the project.
- [ ] **[css to complete styling]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/PeteUgwu/Leaderboard-app/issues).
> Please give this project repo a star⭐️
If you like this project...
> Give credit to everyone who inspired your codebase.
I would like to thank...
> Add at least 2 questions new developers would ask when they decide to use your project.
- **[Question_1]**
- [what are the prerequisites]
- **[Question_2]**
- [how do i go about installing it]
This project is [MIT](./LICENSE) licensed.