Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/besufekad-haz/leaderboard-apis

The leaderboard website displays scores submitted by different players. It also allows them to submit their score. All data is preserved thanks to the external Leaderboard API service.
https://github.com/besufekad-haz/leaderboard-apis

Last synced: 16 days ago
JSON representation

The leaderboard website displays scores submitted by different players. It also allows them to submit their score. All data is preserved thanks to the external Leaderboard API service.

Awesome Lists containing this project

README

        



logo

README

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Screenshot](#screenshot)
- [Loom Presentation Video](#loom-video)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [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

A website for organizing daily activities

["The-leaderboard"] :- is a website that 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(using Notion).

## 🛠 Built With HTML,CSS and Javascript

### Tech Stack

Client

Server

Database

### Key Features

- **[HTML]**
- **[CSS]**
- **[Javascript]** ---> with ES6
- **[Webpack]**
- **[API's(Notion)]**

(back to top)

## 🚀 Screenshot

![image](https://user-images.githubusercontent.com/23375153/224085035-76f1202f-c6d9-4fb2-824d-7af93887b1ce.png)

## 💻 Loom Presentation Video

- not available yet.

## 🚀 Live Demo

- [Live Demo Link](https://besufekad-haz.github.io/Leaderboard-APIs/dist/)

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

-A Computer (MAC or PC)
-code editor (VSCode,Atom etc...)
-A browser (Chrome,Mozilla,Safari etc...)
-Version Control System (Git and Github)
-NodeJS (https://nodejs.org/en/)
-Webpack {https://webpack.js.org}

### Setup

Clone this repository to your desired folder:

cd my-folder
git clone [email protected]:Besufekad-HAZ/Leaderboard-APIs.git (SSH)

### Install

Install this project with:

npx webpack init
npm init -y
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
npm install --save-dev [email protected] [email protected] [email protected] [email protected]

### Run tests

To run tests, run the following command:

To check Styelint error:-

npx stylelint "\*_/_.{css,scss}"

To check Eslint error:-

npx eslint .

### Deployment

You can deploy this project using:
Github Pages.

(back to top)

## 👥 Authors

👤 **Besufekad Alemu**

- GitHub: [@Besufekad-HAZ](https://github.com/Besufekad-HAZ)
- Twitter: [@BesufekadAlemu7](https://twitter.com/BesufekadAlemu7)
- LinkedIn: [@besura](www.linkedin.com/in/besura)

(back to top)

## 🔭 Future Features

- [ ] **[Adding_JavaScript_Popups_and_full_functionality]**
- [ ] **[Deploying_the_page_on_github]**
- [ ] **[Adding_backend_and_databases]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Besufekad-HAZ/Leaderboard-APIs/issues).

(back to top)

## ⭐️ Show your support

If you like this project rate it and give it a star.

(back to top)

## 🙏 Acknowledgments

--> I would like to thank the Microverse team for allowing us to work on this Leaderboard API project.

(back to top)

## 📝 License

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._

(back to top)