a microservice wrapper around Pa11y and Outline-Audit for reports on semantics and accessibility.

usage 📡

A11y-Reporter accepts only POST requests, with 2 keys in the body:

• url: the absolute url of the page it is intended to test
• filterList: the array of codes you intend to check for (check all possible codes at Pa11y wiki)

example

const a11yReport = async () => {
  const response = await fetch('https://your-a11y-audit-instance.now.sh', {
    url: 'https://atila.fassina.eu',
    filterList: [
      'WCAG2AA.Principle1.Guideline1_1.1_1_1.H37',
      'WCAG2AA.Principle1.Guideline1_1.1_1_1.H30.2',
      'WCAG2AA.Principle1.Guideline1_1.1_1_1.G94.Image'
    ]
  })

  return response.json()
}

creating your own instance 🛰

Alternatively, you can also clone this repository and deploy it to the PAAS of your choice 😉