Giter VIP home page Giter VIP logo

simonphumin / pa11y-pipeline-dashboard Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mandrasch/pa11y-pipeline-dashboard

0.0 0.0 0.0 426 KB

Experimental: A tiny pa11y dashboard without installing an extra server, report generation is done in GitHub actions.

Home Page: https://mandrasch.github.io/pa11y-pipeline-dashboard/

License: MIT License

JavaScript 42.46% HTML 6.90% SCSS 10.41% Svelte 40.23%

pa11y-pipeline-dashboard's Introduction

pa11y pipeline dashboard

Run automated accessibility tests in GitHub actions, no extra server needed.

Powered by SvelteKit, pico.css, pa11y-ci and GitHub actions.

Experimental project inspired by https://github.com/pa11y/pa11y-dashboard.

Big kudos to the pa11y-team for providing these helpful tools as open source! ๐Ÿ‘ ๐Ÿ‘ ๐Ÿ‘

Demo

Screenshot of dashboard, 3 sites with multiple errors

https://mandrasch.github.io/pa11y-pipeline-dashboard/

Generate reports

Go to GitHub actions ยป generate reports ยป start report generation with "run workflow".

Local installation

  • npm install
  • Test report generation: npx pa11y-ci
  • Develop frontend dashboard: npm run dev -- -- open

TODOs

  • axe + htmlcs will lead to duplicates? how to present this better? what is the default?
  • Update to WCAG 2.1 AA possible?
  • (npm ...) || true is suboptimal, but otherwise exit code 2 will be sent?
  • Use shiki for HTML syntax highlighting?

How was this created?

npm create svelte@latest .
npm install --save-dev pa11y-ci
npm i --save-dev prettier-plugin-svelte prettier
npm i --save-dev sass svelte-preprocess @sveltejs/adapter-static
npm i @picocss/pico

pa11y-ci config

See .pa11yci.

Troubleshooting

  • Timeout is important. If it is too short, pa11y-ci will fail without notice.

Resources


SvelteKit docs

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

pa11y-pipeline-dashboard's People

Contributors

mandrasch avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.