/Leaderboard

Primary LanguageJavaScript

LEADERBPARD | MODULE-II

Leadboard is simple application being built in our second module of our curriculum at microverse. its s score Leaderboard application were you are able to Add your score which will be displayed on the Leaderboard. All data is preserved thanks to the external Leaderboard API service.

Features implemented so far are:

  • Responsive HTML page
  • Proper ES6 Syntax
  • ES6 modules to write modular JavaScript.
  • Webpack to bundle JavaScript.

Built With

  • Lighthouse (An open-source, automated tool for improving the quality of web pages. It has audits for performance, accessibility, progressive web apps, SEO and more).
  • Webhint (A customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors).
  • Stylelint (A mighty, modern linter that helps you avoid errors and enforce conventions in your styles).
  • ESlint (A mighty, modern linter that helps you avoid errors and enforce conventions in JavaScript codes)
  • Frameworks: N/A
  • Technologies used: Webpack, API

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

Prerequisites

The basic requirements for building the executable are:

  • A working browser application (Google chrome, Mozilla Fire fox, Microsoft edge ...)
  • VSCode or any other equivalent code editor
  • Node Package Manager (For installing packages like Lighthous, webhint & stylelint used for checking for debugging bad codes before deployment)

Getting Started

Cloning the project

git clone https://github.com/L2oukmane/Awesome-Books-App-Version-II.git <Your-Build-Directory>

Getting started with Webpack

npm install webpack webpack-cli --save-dev

Getting packages and debuging with Stylelint

npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
For validation detection using Stylelint Run
npx stylelint "**/*.{css,scss}"
from parent source directory

Getting packages and debuging with ESlint

 npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x
For validation detection using Stylelint Run
npx eslint .
from parent source directory

Getting packages and debuging with Webhint

npm init -y
npm install --save-dev hint@6.x
To Compile and See a live Version, Run
npm run build

npm run start
For validation detection using Webhint Run
npx hint .
from parent source directory

License

All source code files are licensed under the permissive zlib license (http://opensource.org/licenses/Zlib) unless marked differently in a particular folder/file.

Author