Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnftitor/leaderboard
This website is a Leader Board App list using the Leaderboard API and JavaScript async and await functionality. It allows the user to submit scores and retrieve data of previously saved scores from a private game created the first time the page is opened. Have fun!
https://github.com/johnftitor/leaderboard
html javascript jest scss webpack
Last synced: 11 days ago
JSON representation
This website is a Leader Board App list using the Leaderboard API and JavaScript async and await functionality. It allows the user to submit scores and retrieve data of previously saved scores from a private game created the first time the page is opened. Have fun!
- Host: GitHub
- URL: https://github.com/johnftitor/leaderboard
- Owner: JohnFTitor
- Created: 2022-01-25T16:59:14.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-03-04T22:18:48.000Z (over 2 years ago)
- Last Synced: 2023-03-05T12:31:41.371Z (over 1 year ago)
- Topics: html, javascript, jest, scss, webpack
- Language: JavaScript
- Homepage: https://johnftitor.github.io/leaderBoard/
- Size: 6.97 MB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Leader Board: Hit the API!
> This simple project aims to connect to an API to fetch score data and display it on a LeaderBoard box, as well as provide the tool to submit a new score.
)
How much did you score last time you played with friends? What about having a healthy but fun competition? Keep track of your points with the LeaderBoard!.
## Built With
- HTML/SCSS, JavaScript
- WebPack, Jest
- Visual Studio Code
## Live Demo
[Live Demo Link](https://johnftitor.github.io/leaderBoard/)
## Getting Started
To get a local copy up and running follow these simple example steps.
- Clone this repository with git clone```https://github.com/JohnFTitor/leaderBoard.git``` using your terminal or command line.
- Change to the project directory by entering :
```cd leaderBoard``` in the terminal
### Prerequisites
You need to make sure to have installed the latest version of Node.js and npm on your computer.
### Setup
You can clone this repository or simply download the files as a .zip
If you want to set up a personal repository based on this one, you can as well fork it.
### Install
After clone it and before working on it, you have to run ```npm install``` so that all the dependencies of the project get downloaded in your pc locally.
Such dependencies include webpack and linters checks, for which you have to either generate your own config file or get one.
Note: If you're a Microverse's Student, you should use the config files provided by the program.
[Linters Config HTML/CSS and JS](https://github.com/microverseinc/linters-config/tree/master/html-css-js)
### Usage
You're free to use this project however you like it for educational purposes. Just keep in mind the acknowledgment described below
### Run linters checks
Linter Checks are automatically run with Github actions when there's a pull request. If you want to run them locally, remember to have the config file in the root of the local project.
### Deployment
The deployment can be found in the Github Pages of this repository or through the link provided above
## Authors
👤 **Andrés Felipe Arroyave Naranjo**
- GitHub: [@JohnFTitor](https://github.com/JohnFTitor)
- Twitter: [@johnftitor](https://twitter.com/johnftitor)
- LinkedIn: [Andres](https://www.linkedin.com/in/andresarroyavenaranjo/?locale=en_US)
## Acknowledgments
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](./MIT.md) licensed.