Metadrop / ddev-pa11y

Aljibe ddev addon to add pa11y service

DDEV Pa11y Add-on

• What is DDEV Pa11y Add-on?
• Components of the repository
• Getting started

What is DDEV Pa11y Add-on?

This repository provides a DDEV add-on for the Pa11y service. Pa11y is an automated accessibility testing tool that helps developers make their web applications more accessible.

This is optimized for Aljibe projects, but can be used in any DDEV project.

In DDEV, addons can be installed from the command line using the ddev get command, for example, ddev get Metadrop/ddev-pa11y.

Components of the repository

• The fundamental contents of the Pa11y addon. For example, in this template there is a docker-compose.pa11y.yaml file.
• An install.yaml file that describes how to install the Pa11y service.
• A test suite in test.bats that makes sure the Pa11y service continues to work as expected.
• Github actions setup so that the tests run automatically when you push to the repository.

Getting started

1. Install the Pa11y service in your DDEV project by running ddev get Metadrop/ddev-pa11y.
2. Start the DDEV project with ddev start or ddev restartif already started.
3. Run the Pa11y service with ddev pa11y http://metadrop.net --reporter=junit --standard WCAG2A.

Contributed and maintained by @Metadrop