A11y-Sitechecker-Dashboard

It is a dashboard to present the results from A11y-Sitechecker.

Setup

You can use this tool in your application. There have to be done a few steps:

Install

npm install a11y-sitechecker-dashboard | yarn add a11y-sitechecker-dashboard

Attention: use npm or yarn and don't mix it!

provide a config token with settings

providers: [
    {
      provide: 'configToken', useValue: {serverMode: false, showToolbar: true, sitecheckerFolder: 'assets/dashboard/'}
    }
  ],

Attention: sitecheckerFolder is essential to be correct!

provide the routes in your routerModule

const routes: Routes = [
  {
    path: '',
    loadChildren: () =>
      import('a11y-sitechecker-dashboard').then((m) => m.A11ySitecheckerDashboardModule),
  },
];

Endpoints for providing server side results (Currently not working with version > 2.0.0)

get /sites => AnalyzedSite[]
get /siteResults/:id => SiteResult[]
post /violations/:id (data: timestamp) => FullCheckerSingleResult[]
post /incompletes/:id (data: timestamp) => FullCheckerSingleResult[]
post /inapplicables/:id (data: timestamp) => FullCheckerSingleResult[]
post /passes/:id (data: timestamp) => FullCheckerSingleResult[]

Expected Timeline

• v2.2: Support for data from servers
• v2.3: Better tests for consistency and stability
• v2.4: Better explanation for users