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

https://github.com/oscah01/leaderboard

This project is about a leaderboard website which displays scores submitted by different players. It also allows to add score and preserved data from external API.
https://github.com/oscah01/leaderboard

css html javascript webpack

Last synced: 3 months ago
JSON representation

This project is about a leaderboard website which displays scores submitted by different players. It also allows to add score and preserved data from external API.

Awesome Lists containing this project

README

          


Leaderboard

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [:camera: project screenshot](#screen-shoot)
- [🛠 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)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Leaderboard

> This repository a leaderboard website displays scores submitted by different players. It also allows to add score and data were preserved data external API.

## 🛠 Built With

> HTML 5 , css3, javascript ES6, NPM and webpack.

### Tech Stack

> HTML 5 , css3, javascript ES6, NPM and webpack

### Key Features

  • Display score

  • Allow submit score
  • (back to top)

    ## 🚀 Live Demo https://oscah01.github.io/leaderboard/

    >

    (back to top)

    ## 💻 Getting Started

    to run on your localhost clone the project to local folder

    > cd Leaderboard
    > npm i
    > npm run server
    > open your brower locate to localhost:3000

    ### Setup

    >

    git clone https://github.com/Oscah01/leaderboard.git


    > cd Leaderboard

    (back to top)

    ### Prerequisites

    In order to run this project you only need:

    - latest web-browser
    - node.js and npm

    ### Install

    To install this project in your local machine use

    > npm i
    > npm run build

    ### Usage

    To run the project, execute the following command:

    > In visual studio code Go to dist folder then open index.html in live server.

    ## 👥 Authors

    👤 **Oscar Deus**

    - GitHub: [@oscah01](https://github.com/oscah01)
    - Twitter: [@alphonce_isaya](https://twitter.com/alphonce_isaya)
    - LinkedIn: [oscardeus](https://www.linkedin.com/in/oscardeus/)

    ## 🔭 Future Features

    > Use external API

    ## 🤝 Contributing

    Contributions, issues, and feature requests are welcome!

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

    (back to top)

    ## ⭐️ Show your support

    > If you like the project please give it star

    (back to top)

    ## 🙏 Acknowledgments

    > I would like to thank Microverse team

    (back to top)