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

https://github.com/tsohledev/leaderboard

Leader board is a website that uses a API to show and store score of different clients across the world
https://github.com/tsohledev/leaderboard

html5 javascript sass

Last synced: about 2 months ago
JSON representation

Leader board is a website that uses a API to show and store score of different clients across the world

Awesome Lists containing this project

README

          

# Leaderboard

"Leaderboard is a project for practice API calling from the front by using Asynchronous programming to the request and data from the API, we use an external [API from microverse](https://www.notion.so/microverse/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3)

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 About the project

## 🛠 Built With
HTML
SCSS
Javascript

(back to top)

## 🚀 Live Demo

[To Do list live demo]( https://tsohleDev.github.io/Leaderboard/dist/)

(back to top)

## 💻 Getting Started

- Create a local directory that you want to clone the repository.

- Open the command prompt in the created directory.

- On the terminal run this command -

```sh
git clone [https://github.com/tsohleDev/Leaderboard.git]
```

- Go to the repository folder using command prompt
```sh
cd Leaderboard
```

- Install the dev dependencies for linters run
```sh
npm install.
```
- To start run
```sh
npm start
```

(back to top)

### Prerequisites

In order to run this project you need:

-A working browser application (Google chrome, Mozilla Fire fox, Microsoft edge ...)

-VSCode or any other equivalent code editor

-Node Package Manager (For running, debuging, or installing dependancies to be used)

node and npm:

-Linux
```sh
sudo apt install nodejs npm
```
-windows

[download and install](https://nodejs.org/en/)

(back to top)

### Setup

Clone this repository to your desired folder:

- Open the command prompt in the created directory.

- On the terminal run this command
```sh
git clone https://github.com/tsohleDev/Leaderboard.git
```

- Go to the repository folder using command prompt
```sh
cd Leaderboard
```

- Install the dev dependencies for linters
```sh
run npm install
```

- To start run
```sh
npm start
```

(back to top)

## 👤**Authors**

Tsohle Mokhemisi

logo[githubhandle](https://github.com/tsohleDev2)


logo [twitterhandle](https://twitter.com/RealTsohle)


logo[linkedIn](https://www.linkedin.com/in/tsohle-mokhemisi-3687401b2/)

(back to top)

## 🔭 Future Features

- Implement additional pages, which will allow the user to Register

- Implement additional pages, which will allow the user to Login

(back to top)

## 🤝 Contributing

> Credits to everyone who inspired the codebase.

I would like to thank [Microverse](https://www.microverse.org/)

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

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments
[Font Awesome](https://fontawesome.com/search?q=book&o=r)

[Webpack](https://webpack.js.org)

[Microverse](https://microverse.org)

(back to top)

## 📝 License

This project is [GNU General Public License v3.0](./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._

(back to top)