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

https://github.com/amazinggracee/leaderboard1

The leaderboard website displays scores submitted by different players. It also allows you to submit your score.
https://github.com/amazinggracee/leaderboard1

css3 html5 javascript modules webpack

Last synced: 3 months ago
JSON representation

The leaderboard website displays scores submitted by different players. It also allows you to submit your score.

Awesome Lists containing this project

README

          


# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [📖 Learning objectives](#objectives)
- [🛠 Built With](#built-with)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [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)

# 📖 [Leaderboard]

**[Leaderboard]** The leaderboard website 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.

## Learning objectives

- Use callbacks and promises.
- Learn how to use proper ES6 syntax.
- Use ES6 modules to write modular JavaScript.
- Use webpack to bundle JavaScript.
- Send and receive data from an API.
- Use API documentation.
- Understand and use JSON.
- Make JavaScript code asynchronous.
- Understand how to use medium-fidelity wireframes to create a UI.

## 🛠 Built With
- **[Html]**
- **[Css]**
- **[JavaScript]**
- **[webpack]**
- **[npm]**
- **[API]**

### Key Features

- [ ] Leaderboard-structure
- [ ] Adding_a_new_score
- [ ] ** API Documentation
- [ ] ** Create a new game
- [ ] ** Implement the "Refresh" button
- [ ] ** Now you should improve the look and feel of the application

(back to top)

## 🚀 Live Demo
https://amazinggracee.github.io/Leaderboard1/dist/

- [Click Here]()

(back to top)

## 💻 Getting Started

You can have a copy of this repo run on your local machine by just directly cloning it.

To get a local copy up and running follow these simple example steps.
1. Download the `Zip` or `(git clone)[https://github.com/Amazinggracee/Leaderboard1.git]`
2. `cd Leaderboard`
3. Then open in your browser by using `live server`

## Test

For tracking linter errors locally you need to follow these steps:

- After cloning the project you need to run this command
> npm install
`This command will download all the dependencies of the project`

- For tracking the linter errors in HTML file run:
> npx hint .

- For tracking the linter errors in CSS file run:
> npx stylelint "**/*.{css,scss}"

- And For tracking the linter errors in JavaScript file run:
> npx eslint .

### Prerequisites

- Basic knowledge of JavaScript
- Basic knowledge of webpack
- Basic knowledge callbacks and promises

To get the output of our project make sure you have google Chrome, Mozila or any other browser installed.

### Install

> In order to install this project please go through the following steps:

1. - [ ] Open the `Terminal`
2. - [ ] Navigate to the directory where you want to add this repository
3. - [ ] Run `git clone https://github.com/Amazinggracee/Leaderboard1.git`
4. - [ ] Run `npm install` to install the necessary modules
5. - [ ] Run `npm start`

(back to top)

## 👥 Authors

👤 **Amarachi Dimkpa**

- GitHub: [@amazinggacee](https://github.com/Amazinggracee)
- Twitter: [@amazinggaceu](https://twitter.com/amazinggraceu)
- LinkedIn: [Amarachi Dimkpa](https://linkedin.com/in/amarachi-dimkpa-070643183)

(back to top)

## 🔭 Future Features

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments

- Hat tip to [Microvers](www.microverse.org) and all the staff
- Thanks to My coding Partners
- Thanks to My Morning-session-group and Standup-team Partners and
- Thanks to Code Reviewers

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)