Leaderboard

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support

📖Leaderboard

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

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript
• ES6
• Webpack

Key Features

• Uses Webpack
• Based on latest ES6 syntax
• Used async and await JavaScript features to consume the API
• Used Leaderboard API

(back to top)

🚀 Live Demo

• Live Demo Link

(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 personal computer connected to the internet
• A Modern/Updated web browser
• Have a local version control like git installed on your computer and a Github account
• Code editor installed on your computer

Setup

Clone this repository to your desired folder:

    cd your-desired-folder
    git clone https://github.com/HanaSabih/leaderboard-project.git

Install

Install this project with:

    cd your-desired-folder
    git clone https://github.com/HanaSabih/leaderboard-project.git

    npm install

Usage

To run the project, execute the following command:

    npm start

(back to top)

Run tests

To run tests, run the following command in your git bash or CLI:

• npx hint . : for the html codebase and use of best practices.
• npx stylelint "**/*.{css,scss}" : for the css codebase and use of best practices. you can add.
• npx eslint . : for the JavaScript codebase and use of best practices.

👥 Authors

👤 Hana Sabih

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

[] Add date and time for each book and store it

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, kindly give a ⭐️.

(back to top)

📝 License

This project is MIT licensed.