https://github.com/hombre2014/leaderboard
The Leader's board website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.
https://github.com/hombre2014/leaderboard
api-rest css html javascript webpack
Last synced: 5 days ago
JSON representation
The Leader's board website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leaderboard API service.
- Host: GitHub
- URL: https://github.com/hombre2014/leaderboard
- Owner: Hombre2014
- License: mit
- Created: 2021-12-21T10:04:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-23T14:15:44.000Z (over 3 years ago)
- Last Synced: 2025-05-12T18:19:24.661Z (5 days ago)
- Topics: api-rest, css, html, javascript, webpack
- Language: JavaScript
- Homepage:
- Size: 380 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license.md
Awesome Lists containing this project
README
# Yuriy Chamkoriyski Leader's board project
> The Leader's board website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external [Leaderboard API service](https://www.notion.so/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3).
## Description
In this activity I will set up a JavaScript project for the Leader board list app, using webpack and ES6 features, notably modules. I should develop a first working version of the app following a wire frame, but without styling - just focus on functionality. In following activities, I will consume the Leader board API using JavaScript async and await and add some styling.
## Instructions:
### Phase 1, setup project
- [x] Use [Gitflow](https://github.com/microverseinc/curriculum-transversal-skills/blob/main/git-github/articles/gitflow.md)
- [x] Create an npm project with [webpack](https://webpack.js.org/guides/output-management/#setting-up-htmlwebpackplugin)
- [x] Write plain HTML markup with minimum styling (just to make the layout), because you will implement styles in the following steps
- [x] Don't make API calls (you'll do it in a following lesson).
- [x] Use ES6 modules, with import and export.
### Phase 2, hit the API
- [x] Read the Leader board API documentation to learn how to use this API.
- [x] Create a new game with the name of your choice by using the API.
- [x] Implement the "Refresh" button (receiving data from the API and parsing the JSON).
- [x] Implement the form "Submit" button (sending data to the API).
- [x] Use `async` and `await` JavaScript features to consume the API.
- [x] No styling is required.
### Phase 3, final touches
- [x] At this point I should have a fully working app that uses only basic styles to make the layout work, according to this wire frame:
- [x] 
- [x] Now you should improve the look and feel of the application, adding the styles of your choice.
- [x] Please keep the general layout of the wire frame, this is the only mandatory requirement.
- [x] You can use plain CSS or any CSS framework, it's up to you.
## Built With
- Major languages: HTML, CSS, JS
- Frameworks: none
- Technologies used: Git, webpack, API
## Live Demo
- [Live Demo](https://chamkoriyski.me/Leaderboard/dist/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Internet connection and browser
- A text editor(preferably Visual Studio Code)
- Browser
### Setup
- No setup required
### Install
- [Git](https://git-scm.com/downloads)
- [Node](https://nodejs.org/en/download/)
### Usage
- Clone the repository using `git clone [email protected]:Hombre2014/Leaderboard.git`
- Change directory into the project folder `cd Leaderboard`
- Run `npm install` from the terminal
- Run `npm start` from the terminal
- A new browser will open automatically with application loaded
### Run tests
- N/A
### Deployment
- All the files necessary for deployment are in the /dist folder
## Author
👤 **Yuriy Chamkoriyski**
- GitHub: [@Hombre2014](https://github.com/Hombre2014)
- Twitter: [@Chamkoriyski](https://twitter.com/Chamkoriyski)
- LinkedIn: [axebit](https://linkedin.com/in/axebit)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Hombre2014/Leaderboard/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
## 📝 License
This project is [MIT](./license.md) licensed.