https://github.com/rileymanda/leaderboard
A minimalistic web application that utilizes the leaderboard API to generate scores,read and add game scores.
https://github.com/rileymanda/leaderboard
es6 es6-modules gitflow html5-css3 javascript linters-config webpack5
Last synced: 12 months ago
JSON representation
A minimalistic web application that utilizes the leaderboard API to generate scores,read and add game scores.
- Host: GitHub
- URL: https://github.com/rileymanda/leaderboard
- Owner: RileyManda
- Created: 2023-06-25T14:54:20.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-06-30T21:06:45.000Z (over 2 years ago)
- Last Synced: 2025-01-20T19:24:18.259Z (about 1 year ago)
- Topics: es6, es6-modules, gitflow, html5-css3, javascript, linters-config, webpack5
- Language: CSS
- Homepage: https://rileymanda.github.io/leaderboard/
- Size: 333 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Leaderboard
# Table of Contents 📋
- [📖 About the Project](#about-project)
- [🛠 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)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [👥 Attribution](#attribution)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**Leaderboard** Is a minimalistic web application that utilizes the leaderboard API to generate scores,read and update game scores.
Client
-
HTML5 markup to build raw structure of this web page -
CSS3 custom properties, FlexBox, Grid to make the website visually attractive - Javascript
-
Linters for coding convention and coding formating
Javascript runtime environment
-
Node JS as a javascript runtime machine [git], a free and open source distributed version control system
Deployment
Bundler
Version Control
Backend
- **WebPack project setup**
- **Simple Leader User interface**
- [Live Demo Link](https://rileymanda.github.io/leaderboard/)
To get a local copy up and running, follow these steps.
In order to run this project you need:
- A Github account
- Node JS
- A web browser to view output e.g [Chrome](https://www.google.com/chrome/).
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/RileyManda/Leaderboard.git
```
- Navigate to the folder
```
cd my-folder
```
- Checkout the branch
```
git checkout main
```
Install all dependencies:
```sh
npm install
```
To run the project, follow these instructions:
- You have to clone this repo to your local machine.
```
git clone https://github.com/RileyManda/Leaderboard.git
```
### Run tests 🧪
How should it be tested?
To run tests, run the following command:
- HTML linter errors run:
```
npx hint . --fix
```
- CSS linter errors run:
```
npx stylelint "**/*.{css,scss}" --fix
```
- JavaScript linter errors run:
```
npx eslint . --fix
```
- For unit testing, run:
```
npm test
```
This project was deployed using GitHub Pages. For more information about how to use GitHub pages [read here](https://www.w3schools.com/git/git_remote_pages.asp?remote=github) 🤩.
If you want to watch a video about how to use GitHub pages instead of reading [click here](https://www.youtube.com/watch?v=QyFcl_Fba-k&t=251s) ☺️.
👤 **Riley Manda**
- GitHub: [@RileyManda](https://github.com/RileyManda)
- Twitter: [@rilecodez](https://twitter.com/rilecodez)
- LinkedIn: [rileymanda](https://www.linkedin.com/in/rileymanda/)
- [ ] **Perform Api calls from leaderboard API**
- [ ] **CRUD Operations:Read,Add,Update Scores**
## 👥 Attribution
- ProjectIcon: [Svgrepo](https://www.svgrepo.com/)
If you have suggestions 📝, ideas 🤔, or bug reports 🐛, please feel free to open an [issue](https://github.com/RileyManda/Leaderboard/issues) on GitHub.
Remember, every contribution, no matter how big or small, makes a difference.
Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:
- Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.
- Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.
- Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.
I would like to express my sincere gratitude to [Microverse](https://github.com/microverseinc), the dedicated reviewers, and collaborators. Your unwavering support, feedback, and collaborative efforts have played an immense role in making this journey a resounding success. I am truly grateful for your contributions and for being an integral part of my achievements. Thank you for your continued support.
- **Question_1**
Do I have to use the vs code specifically?
- Answer_1
You can use any code editor of your choice.
- **Question_2**
Where can I download node JS for installation?
- Answer_2
Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
It can be downloaded here: https://nodejs.org/en/download/Node.jsNode.js
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._