An open API service indexing awesome lists of open source software.

https://github.com/powerlevel9000/leaderboardwithapi

This is rat race leaderboard . you can add scores of the imaginary game you played .it is build with api so one you will add your score so it will be visibles to whomsoever vists on website
https://github.com/powerlevel9000/leaderboardwithapi

api html5 javascript sass webpack

Last synced: about 1 year ago
JSON representation

This is rat race leaderboard . you can add scores of the imaginary game you played .it is build with api so one you will add your score so it will be visibles to whomsoever vists on website

Awesome Lists containing this project

README

          


logo



Rat Leader Board






logo

# ๐Ÿ“— Table of Contents

- [๐Ÿ“– About the Project](#about-project)
- [๐Ÿงช Linters And Deployment](#linters)
- [๐Ÿ›  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)
- [๐Ÿ“ License](#license)

# ๐Ÿ“– Leader Board

It is project which keep your score and display it to other and other's to you as well

**Leader Board** is a api based application for showing scores of various people

## ๐Ÿงช Linters And Deployment
[![Linters](https://github.com/PowerLevel9000/LeaderboardWithApi/actions/workflows/linters.yml/badge.svg)](https://github.com/PowerLevel9000/LeaderboardWithApi/actions/workflows/linters.yml)
[![pages-build-deployment](https://github.com/PowerLevel9000/LeaderboardWithApi/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/PowerLevel9000/LeaderboardWithApi/actions/workflows/pages/pages-build-deployment)

## ๐Ÿ›  Built With

### Tech Stack

In this project I used my skills, tech and libraries

Documentation

Styling

Dynamics And Logics

Environment

### Key Features

Following features you should observe

- **You can add your scores**
- **You can check others Scores**
- **you can play**
- **Animation of the page working properly with glow effect**

(back to top)

## ๐Ÿš€ Live Demo

This link will guide you to my project live link ๏ผˆ๏ฟฃ๏ธถ๏ฟฃ๏ผ‰โ†—ใ€€

(back to top)

## ๐Ÿ’ป Getting Started

For having local file and project you can fork this repo or clone it using `git clone https://github.com/PowerLevel9000/LeaderboardWithApi.git`
And for making changes you you should follow prerequisites

### Prerequisites

In order to edit this project you need:

- Any text editor such as note pad and word pad
- A web browser
- Node js installed
- An IDE

#### Suggested IDE
- Visual studio code `I prefer this one ๐Ÿ™ƒ๐Ÿ™ƒ`
- Atom
- Sublime
- IntelliJ IDEA
- Visual code

### Setup

Clone this repository to your desired folder:

- Open your terminal there (bash cmd powershell run etc...) and run `npm i` to install node modules
- `npm run dev` or `npm run start` this will open project in browser
- If you want to edit something edit in src dir and then run in terminal `npm run build` to build it for production

- Before deployment have some linter check
- [ ] `npx stylelint "**/*.{css,scss}"` for css and saas file
- [ ] `npx eslint .` for js files
- [ ] `npx hint .` for html files

- After fixing error build deploy for production

### Install
```
npm i
```
### Usage

- For displaying the Leading Score and scorer
- Checking other player score around the World

### Run tests

- Currently, this Project don't have any Unit test
- You can do manual checking
- Score added properly
- Form validation for score and scorer work properly

### Deployment

You can deploy this project using:

- For this repo and use gh pages to deploy it

(back to top)

## ๐Ÿ‘ฅ Authors

๐Ÿ‘ค **Adarsh Pathak**

- GitHub: [@PowerLevel9000](https://github.com/githubhandle)
- Twitter: [@PowerLevel9002](https://twitter.com/PowerLevel9002?t=AIuSN7mTxk5a_MWpLolEjA&s=09)
- LinkedIn: [@Adarsh Pathak](https://www.linkedin.com/in/adarsh-pathak-56a831256/)

## ๐Ÿ”ญ Future Features

- [ ] **Improved Navigation Bar**
- [ ] **Improve functionality**
- [ ] **Improve styling**
- [ ] **Responsive Design**

(back to top)

## ๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## โญ๏ธ Show your support

If you like my Project give it a Star โœจ๐ŸŒŸ Or buy Me a Coffee ๐Ÿฅ‚

(back to top)

## ๐Ÿ™ Acknowledgments

I want to thank microverse and standup team for providing opportunity and guidance to show my skills

Music ยฉ๏ธ to my beloved Alan Walker

(back to top)

## ๐Ÿ“ License

This project is [MIT](https://github.com/PowerLevel9000/LeaderboardWithApi/blob/dev/LICENSE) licensed.

(back to top)