https://github.com/ashmalzahra/leaderboard

The leaderboard website displays scores submitted by different players. The website is build according to the medium-fidelity wireframe to create a UI. For this application the priority is to create a working version of the leaderboard that preserves user input.
https://github.com/ashmalzahra/leaderboard

api-rest best-practices deployment gitflow html-css-javascript

Last synced: 23 days ago
JSON representation

The leaderboard website displays scores submitted by different players. The website is build according to the medium-fidelity wireframe to create a UI. For this application the priority is to create a working version of the leaderboard that preserves user input.

• Host: GitHub
• URL: https://github.com/ashmalzahra/leaderboard
• Owner: ashmalzahra
• License: mit
• Created: 2023-01-31T17:57:12.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-04-13T22:42:04.000Z (over 1 year ago)
• Last Synced: 2024-12-06T03:44:38.695Z (about 1 month ago)
• Topics: api-rest, best-practices, deployment, gitflow, html-css-javascript
• Language: JavaScript
• Homepage:
• Size: 275 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 📗 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](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 Leaderboard 

 The leaderboard 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/microverse/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3).

## Built With

- HTML, CSS, JavaScript

- VSCode

- Webpack

### Tech Stack 

  Client

  


    
JavaScript

  

  


    
Html

  

  


    
CSS

  


  Server

  


    
N/A

  


Database

  


    
LocalStorage

  


(back to top)


### Key Features 

- **[Git Flow]**

- **[Good HTML, CSS and JS practices]**

- **[ES6, modules]**

(back to top)


## Live Demo

[Live Demo Link](https://leaderboard-app-lqug.onrender.com/)

## 💻 Getting Started 

Clone this repository to get started with the project, make sure to configure linters by following the instructions in the [Linters README file](https://github.com/microverseinc/linters-config/blob/master/README.md)

(back to top)


### Prerequisites

In order to run this project you need:

- A working computer.

- Connection to internet.

- [npm](https://www.npmjs.com/) and [Node.js](https://nodejs.org/en/) installed, if you don't have them, please follow this [simple installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).

### Setup

- Clone the folder to your local machine.

- Open a local copy of the project in your code editor.

- Open the index.html file from the /dist folder in your browser.

- Run npm install to install all dev dependencies for Linters, Webpack & Babel.

(back to top)


### Usage

To run the project, execute the following command:

   - Run npm run start in your command terminal.

### Run tests

- After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.

- For stylelint errors run:sudo npx stylelint "**/*.{css,scss}" --fix for automatic fix.

(back to top)


## 👥 Authors 

👤 **Ashmal Zahra**

- GitHub: [@ashmalzahra](https://github.com/ashmalzahra)

- Twitter: [@AshmalZahraa(https://twitter.com/AshmalZahraa)

- LinkedIn: [ashmal-zahra](https://www.linkedin.com/in/ashmal-zahra)

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ashmalzahra/Leaderboard/issues).

(back to top)


## ⭐️ Show your support 

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the information provided to build this project.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **Can I use the project for any purpose?**

  - Yes, you can.

- **Is the information saved in any database?**

  - No, all data is saved in Local Storage.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)