shayan1234554321/Leader-board

📗 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
• 🙏 Acknowledgements
• 📝 License

📖 [Leader Board]

The leader-board website displays scores submitted by different players. It also allows you to submit your score. All data is preserved thanks to the external Leader-board API service.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JS
• Webpack

Server

• External API

Database

• External API

Key Features

Plain HTML with basic style Use of webpack

(back to top)

🚀 Live Demo

Live

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• A PC running any operating system like Windows, Linux, or MacOS
• An Internet connection
• Git installed
• Webpack installed
• Knowledge of some basic Git commands

Setup

• Link your PC to GitHub
• Clone this repository to your desired folder:

Clone this repository to your desired folder:

git clone https://github.com/shayan1234554321/Leader-board.git

• Open the file in your code editor

Install

• Setup JavaScript + CSS + HTML linter

Run the following codes in your project folder in your IDE:

npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x

• node_modules

npm install -g node-modules

• webpack

npm install -g webpack

npm install -g webpack-cli

• project dependencies

npm install

Usage

To run the project, execute the following command:

Start the server

npm run start

Run tests

To run Stylelint and ESLint tests, run the following commands respectively:

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

npx eslint .

Deployment

To deploy this project run

npm run deploy

(back to top)

👥 Authors

👤 Shayan

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Create a new game using an API]
• [Implement the "Refresh" button that will get all scores for a game created by you from the API]
• [Implement the form "Submit" button that will save a score for a game created by you]
• [Use async and await JavaScript features to consume the API]
• [Better styling]

(back to top)

🤝 Contributing

You can contribute to this project by writing an issue here

(back to top)

⭐️ Show your support

If you like this project please leave a ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and youtube for help

(back to top)

📝 License

This project is MIT licensed.

(back to top)