@quall/core

quall yet another Web Quality Tool

Quick start

Installation

In any project (it can be another project than the one you want to run in quall) install the @quall/core package

npm i --save-dev @quall/core

Config

quall wont work until you give some runner to execute on your website, so let's create a config file named .quallrc in the root folder of your project containing some data :

{
  "name": "MFW report",
  "pages": [
    {
      "url": "https://motherfuckingwebsite.com/",
      "label": "A Bare website with almost nothing in it but text",
      "id": "mfw_report"
    }
  ],
  "runners": ["@quall/axe-core"]
}

here we ask for a runner named @quall/axe-core, we need to install him as well :

npm i --save-dev @quall/axe-core

Running an audit

Okay everything is ready we can just run :

# it's better to add those commands to your package.json
# Bare report
quall

# Output directory
quall --output-dir "mfw-quall-report"

REST Usage

To use the restAPI you need to POST to /audit with the config as application/json

outputDir and reportType properties will be ignored when dealing with the REST API.