Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timbar09/leaderboard
Leaderboard is a simple list app that displays a list of users and their game score data which is manipulated by an API using JavaScript async and await.
https://github.com/timbar09/leaderboard
api async-await es6 promises webpack
Last synced: 8 days ago
JSON representation
Leaderboard is a simple list app that displays a list of users and their game score data which is manipulated by an API using JavaScript async and await.
- Host: GitHub
- URL: https://github.com/timbar09/leaderboard
- Owner: Timbar09
- License: mit
- Created: 2023-01-31T08:50:02.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-02-10T10:38:29.000Z (almost 2 years ago)
- Last Synced: 2024-12-19T13:55:13.307Z (about 1 month ago)
- Topics: api, async-await, es6, promises, webpack
- Language: CSS
- Homepage: https://timbar09.github.io/Leaderboard/dist/
- Size: 178 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
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)
- [👥 Author](#author)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**Leaderboard** is a simple list app that displays a list of users and their game scores data which is manipulated by an API using JavaScript async and await.
Client
- **Javascript Async and Await**
- **ES6**
- **Webpack**
- **Gitflow**
- Visit the live demo [here](https://timbar09.github.io/Leaderboard/dist/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- A browser (e.g. Firefox)
- An IDE (e.g. [Vususal Studio Code](https://code.visualstudio.com/download))
- [npm](https://nodejs.org/en/)
- [Webpack](https://webpack.js.org/)
### Setup
To clone this repository to your desired folder, follow the steps below:
**Using the command line**
- Use the following commands
```sh
cd my-folder
git clone https://github.com/Timbar09/Leaderboard.git
```
**Using GitHub Desktop app**
- Follow the steps below
- Visit this link "https://github.com/Timbar09/Leaderboard.git"
- Click the green button labelled "code"
- Select the "Open with GitHub Desktop" option
- After the GitHub Desktop add opens, click the "clone repo" button
### Install
Install this project's dependencies with the following command:
```sh
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm start
```
### Run tests
To run tests, run the following command:
```sh
npm test
```
### Deployment
You can deploy this project by:
- visiting your repository on [GitHub](https://github.com)
- Click on settings
- Go to the "Pages" option
- Select the main branch and save
| 👤 Author | GitHub | Twitter | LinkedIn |
| :-- | :-- | :-- | :-- |
| Miles Mosweu | [@Timbar09](https://github.com/Timbar09) | [@Milez09](https://twitter.com/Milez09) | [@miles09](https://www.linkedin.com/in/miles09) |
|
- [ ] **Implement more functionality.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Timbar09/Leaderboard/issues).
If you like this project, give it a ⭐️ and let me know what you like in particular.
I would like to thank the whole Microverse community for their help and contributions towards this project.
This project is [MIT](./LICENSE) licensed.