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
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
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
- GitHub: @JohnFTitor
- Twitter: @johnftitor
- LinkedIn: Andres
Acknowledgments
Show your support
Give a
π
License
This project is MIT licensed.