David-Lanzz/Leaderboard-Project

📗 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
• [FAQ]
• 📝 License

📖 [LEADERBOARD-PROJECT]

Leaderboard-Project is a project i worked to help clients store scores acquired in a game in an external API for future reference.

🛠 Built With

Visual Studio Code GitHub

Tech Stack Frontend Technology

The Tech stack used in this project is the frontend technology and it consists of just the index.html,scipt.js and styles.css and webpack.

Cascading Style Sheet

• CSS

Mark-Up Language

• HTML

JavaScript

• JavaScript

Key Features

• [Fresh quality content]
• [Speed and responsive]
• [Easy to use]
• [Adding of scores to an external API]

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

• git clone https://github.com/David-Lanzz/Leaderboard-Project.git
• cd my-project
• npm install

Prerequisites

In order to run this project you need: A browser A good internet connection Visual Studio Code[OPTIONAL]

Setup

Clone this repository to your desired folder:

• git clone https://github.com/David-Lanzz/Leaderboard-Project.git
• cd my-project
• npm install
• npm start

Install

Install this project with:

• cd Leaderboard-Project
• npm install

Usage

To run the project, Click on the live Demo link or...

• clone the project
• install all dependencies
• run npm start in the terminal

Run tests

To run tests, run the following command: npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x npx stylelint "**/*.{css,scss}"

npm install --save-dev hint@7.x npx hint .

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

Deployment

You can deploy this project using:

githack and github pages

(back to top)

👥 Authors

👤 Author1

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

👤

(back to top)

🔭 Future Features

• [A feature that allows users create new game leaderboads]

(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... please leave me a comment in my twitter account, Thankyou

(back to top)

🙏 Acknowledgments

I will like to give kudos to Microverse for assigning the creation of this project to me.

(back to top)

FAQ

• How did you get the linters to work for the html and CSS

  • Move into the project directory, copy and run the following commands:

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

  then: npx stylelint "**/*.{css,scss}" to test for CSS and npx hint . for HTML

• How did you align the elements to stack on or beside eachother

• Use css flex or grid boxes

(back to top)

📝 License

This project is MIT licensed.

(back to top)