Skip to content

a11y-dashboard/frontend

Repository files navigation

Accessibility Dashboard Frontend

This project is the front end part of the Accessibility Dashboard. It allows a visitor to see an aggregated overview of accessibility issues and has features that allows to drill into this aggregated data and view issues per URL and filter them by standards.

Landing page:

a11y-dashboard-landing.png

Detail view:

a11y-dashboard-details.png

It needs backing by the Accessibility Dashboard Webservice.

Project Features

  • Overview charts for data in an instance of the Accessibility Dashboard Webservice.
  • Drilling down into a project and showing per-URL errors.
  • Filtering by URL, error level and tag (standard)

Getting started

You should download and spin up an instance of the Accessibility Dashboard Webservice first and then use the WEBSERVICE_URL environment variable to point the Dashboard against it. For an example you can have a look at the dotfiles in /test and the according command in package.json.


How to contribute

PRs are welcome!

You can spin up a dev instance via running npm run dev:local:local - it is also possible to point the dashboard frontend to an existing docker instance running the backend. Have a look at package.json for some examples.

Make sure your code lints (npm run lint) and the tests are green (npm test).