nejidevelops/LeaderBoard

LeaderBoard

📗 Table of Contents

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

📖 LeaderBoard

This is a Leaderboard project that consume an API and allow interactivity and communication with the API.

[LeaderBoard] is a HTML CSS and JS project.

🛠 Built With

Tech Stack

• HTML
• CSS
• Js
• Linters
• Webpack
• API

Key Features

• Understanding Git, GitHub and GitHub Workflow
• Configuring Linters
• Changing design template to code
• Interacting with the DOM
• Working with webpack
• Consumption of APIs.
• Async, Callbacks and Promise

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Visual Studio Code
• Nodejs
• NPM

Setup

Clone this repository to your desired folder:

  cd Leaderboard
  git clone git@github.com:NewtonOmbese/LeaderBoard.git

Install

Install this project with:

  cd Leaderboard
  npm install

Usage

To run the project:

  npm run start
      or
  npm start

Run tests

To run tests, run the following command:

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

Deployment

You can deploy this project using:

  gh-pages
  netlify
  vercel

👥 Authors

👤 Newton Ombese

• GitHub: NewtonOmbese
• Twitter: NewtonOmbese
• LinkedIn: Newton Ombese

🔭 Future Features

• Add a more attractive UIs

🤝 Contributing

Contributions, issues, and feature requests are welcome!

⭐️ Show your support

If you like this project you can go ahead give a star to the repository.

🙏 Acknowledgments

I would like to thank Microverse for the opportunity and I look forward to making it count.

📝 License

This project is MIT licensed.