https://github.com/nitbravoa92/leaderboard-api
This project consists of creating a single page application with HTML, CSS and Javascript that allows to register and list the score of different players in different games, using the Leaderboard API to access and preserve the data.
https://github.com/nitbravoa92/leaderboard-api
api-rest css3 ecmascript6 html5 javascript webpack
Last synced: about 16 hours ago
JSON representation
This project consists of creating a single page application with HTML, CSS and Javascript that allows to register and list the score of different players in different games, using the Leaderboard API to access and preserve the data.
- Host: GitHub
- URL: https://github.com/nitbravoa92/leaderboard-api
- Owner: NitBravoA92
- License: mit
- Created: 2023-06-20T15:57:52.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-07-28T20:46:59.000Z (about 2 years ago)
- Last Synced: 2025-09-28T14:43:51.945Z (9 days ago)
- Topics: api-rest, css3, ecmascript6, html5, javascript, webpack
- Language: JavaScript
- Homepage: https://nitbravoa92.github.io/leaderboard-api/
- Size: 639 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Leaderboard App
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [Leaderboard App ](#leaderboard-app-)
- [🛠 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)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**Leaderboard App:** This project consists of creating a single page application with HTML, CSS and Javascript that allows to register and list the score of different players in different games, using the Leaderboard API to access and preserve the data.
Client
- **Minimalist Design**
- **Responsive design**
- **Use of semantic HTML**
- **source code packaged with Webpack**
- **Dynamic content with Javascript**
To see the application working live, you can click on the following link that contains the demo version:
- [Leaderboard Webapp - Live Demo](https://nitbravoa92.github.io/leaderboard-api/)
To get a local copy up and running, follow these steps.
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder-name
git clone git@github.com:NitBravoA92/leaderboard-api.git
```
### Prerequisites
In order to install, modify and run this project, it is necessary to have the following applications installed:
- **Git:** to manage the project versions of source code. [You can Download Git here](https://git-scm.com/)
- **Nodejs and NPM:** to install and manage the project dependencies. [Nodejs and NPM installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- **A code editor** like Visual Studio Code (Recommended) or any other of your preference. It is necessary to open the project and add or modify the source code. [You can Download Visual Studio Code here](https://code.visualstudio.com/)
It is also important to have at least basic knowledge about webpack tool, HTML, CSS and Javascript languages so you will be able to understand and work with the html and css code of the project.
- [Learn the basics of HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
- [Learn the basics of CSS](https://developer.mozilla.org/en-US/docs/Web/CSS)
- [JavaScript basics](https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics)
- [Javascript Arrays](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Array)
- [Javascript Objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
- [JavaScript modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
- [Webpack - Getting Started](https://webpack.js.org/guides/getting-started/)
### Install
Install this project by running the next command into your project folder:
```sh
npm install
```
All the packages and libraries necessary for the project to work will be installed in a folder called /node_module
### Usage
Run the following command to start the application on a development server:
```sh
npm start
```
You only need to run this command once. If you keep making changes to the files, the installed webpack server will reload the page so you can see the changes immediately.
Open the HTML, CSS or Javascript files and modify the internal code, then run the following command to check if your code has any syntax, indentation or spacing errors:
HTML Linter
```sh
npx hint .
```
CSS Linter
```sh
npx stylelint "**/*.{css,scss}"
```
Javascript Linter
```sh
npx eslint .
```
This will show you a log with details about errors (if any) and changes that would be necessary to solve those errors and improve the code.
**Note**: Please only modify the HTML, CSS and Javascript files. Do not modify the configuration files of the project.
When all the code changes are ready, run the following command to have webpack generate the bundle files in your ./dist folder. Those files are optimized for use in production.
```sh
npm run build
```
👤 **Nitcelis Bravo**
- GitHub: [Nitcelis Bravo](https://github.com/NitBravoA92)
- Twitter: [@softwareDevOne](https://twitter.com/softwareDevOne)
- LinkedIn: [Nitcelis Bravo Alcala](https://www.linkedin.com/in/nitcelis-bravo-alcala-b65340158)
- [x] **Create two sections with HTML to submit and display players' score**
- [x] **Make Leaderboard API call and get for list of scores**
- [x] **Make Leaderboard API call to add a new score**
- [x] **Add the final CSS styles to give it a more attractive design**
Contributions, issues, suggestions and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
To do Contributions, please fork this repository, create a new branch and then create a Pull Request from your branch. You can find detailed description of this process in: [A Step by Step Guide to Making Your First GitHub Contribution by Brandon Morelli](https://codeburst.io/a-step-by-step-guide-to-making-your-first-github-contribution-5302260a2940)
If you liked this project, give me a "Star" (clicking the star button at the beginning of this page), share this repo with your developer community or make your contributions.
I would like to thank my Microverse teammates for their support. They have supported me a lot in carrying out this project, giving me suggestions, good advice and solving my code doubts.
This project is [MIT](./LICENSE) licensed.