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

https://github.com/storres20/leaderboard

🌍 LEADERBOARD 🌍 is a webapplication which use API to save and show a list of elements that you saved previously
https://github.com/storres20/leaderboard

bootstrap5 css html javascript webpack

Last synced: 3 months ago
JSON representation

🌍 LEADERBOARD 🌍 is a webapplication which use API to save and show a list of elements that you saved previously

Awesome Lists containing this project

README

          

logo

Microverse leaderboard project

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 [LEADERBOARD] ](#-leaderboard-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)

# 📖 [LEADERBOARD]

> This is the LEADERBOARD project for Module 2.
> It saves the user and score that you introduce in the input form and also, show a refreshed list of all names that you saved previously

**[LEADERBOARD]** is a webapplication which use API to save and show a list of elements that you saved previously

## 🛠 Built With

### Tech Stack

> This web application is based on HTML, CSS, javascript, webpack and linters.

Client

Server

Database

### Key Features

- **[Best practice of code]**
- **[Connected to API]**
- **[Based on HTML, CSS, javascript, webpack]**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://storres20.github.io/leaderboard/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:

- IDE (i.e visual studio code)
- Web Browser (i.e microsoft edge, mozilla, chrome)

### Setup

Clone this repository to your desired folder:

- Choose a directory
- Open a Terminal

```sh
git clone https://github.com/storres20/leaderboard.git
```

### Install

Install this project with:

```sh
npm install
```

### Usage

To run the project, execute the following command:

```sh
npm run start
```

### Run tests

To run tests, run the following command:

```sh
npm run test
```

### Deployment

You can deploy this project using:

(back to top)

## 👥 Authors

👤 **ITALO**

- GitHub: [@storres20](https://github.com/storres20)
- Twitter: [@italolonkan](https://twitter.com/italolonkan)
- LinkedIn: [LinkedIn](https://linkedin.com/in/italo-lon-kan)

(back to top)

## 🔭 Future Features

- [ ] **[Bootstrap styles]**
- [ ] **[Database connection]**
- [ ] **[React js]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project could help you to improve your coding skills and also, you could use it for your personal web application or projects

(back to top)

## 🙏 Acknowledgments

I would like to thank to Microverse for inspiring to build this web application

(back to top)

## ❓ FAQ

- **[Do I need ask for permission to clone this repository?]**

- [No, you don't. It's for free]

- **[Could I ask for help with any issue with this repository?]**

- [Yes, you can. If you need help just contact me]

(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)