Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/usorfaitheloho/leaderboard
This a leaderboard website which displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to an external LeaderBoard API service
https://github.com/usorfaitheloho/leaderboard
css html javascript
Last synced: 18 days ago
JSON representation
This a leaderboard website which displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to an external LeaderBoard API service
- Host: GitHub
- URL: https://github.com/usorfaitheloho/leaderboard
- Owner: usorfaitheloho
- Created: 2022-03-08T13:28:36.000Z (almost 3 years ago)
- Default Branch: development
- Last Pushed: 2022-03-11T16:40:30.000Z (almost 3 years ago)
- Last Synced: 2024-11-11T05:41:19.639Z (3 months ago)
- Topics: css, html, javascript
- Language: JavaScript
- Homepage: https://usorfaitheloho.github.io/Leaderboard/dist/
- Size: 3.31 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Leaderboard
> This is a solo project being built in our second module of our curriculum at microverse. its a Leaderboard application were you are able to add your name and score to the leaderboard with the help of an API your details can be stored and retrieved correctly
Our goal here is to Build a Leaderboard application where you can add your name and score to it with the help of an API. click [here](https://usorfaitheloho.github.io/Leaderboard/dist) to see deployed live version
### Features implemented so far are:
- UI/UX design
- Integrated webpack
- Send and receive data from an API.
## Built With
- Lighthouse (An open-source, automated tool for improving the quality of web pages. It has audits for performance, accessibility, progressive web apps, SEO and more).
- Webhint (A customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors).
- Stylelint (A mighty, modern linter that helps you avoid errors and enforce conventions in your styles).
- ESlint (A mighty, modern linter that helps you avoid errors and enforce conventions in JavaScript codes)
- Webpack (Used for bundling JavaScript files for usage in a browser)
To get a local copy up and running follow these simple example steps.
### Prerequisites
The basic requirements for building the executable are:
- A working browser application (Google chrome, Mozilla Fire fox, Microsoft edge ...)
- VSCode or any other equivalent code editor
- Node Package Manager (For installing packages like Lighthous, webhint & stylelint used for checking for debugging bad codes before deployment)
# Getting Started
#### Cloning the project
```
git clone https://github.com/usorfaitheloho/Leaderboard.git
```
## Getting packages and dependencies
To get all package modules required to build the project run:
```
npm install
```
every package module required to build the project is listed in the package.json file. this is used as a reference to get all dependencies.
## Building
To build the project run:
```
npm run build
```
after you run this sucessfully you'd locate the build from in the ```dist``` folder located from the parent directory of the project. two files are being built which are, ```main.js and index.html```
## Running
To run the program on a browser through a server run this command in your cli
```
npm start
```
This should open the page in your localhost on port 8080. then you'd be able to view the built page generated using webpack.
## License
All source code files are licensed under the permissive zlib license
(http://opensource.org/licenses/Zlib) unless marked differently in a particular folder/file.
## Author
- **Faith-Eloho-Usor** - [github](https://github.com/usorfaitheloho), [linkedin](https://www.linkedin.com/in/faith-usor), [twitter](https://twitter.com/faithusor16)