Skip to content

Latest commit

 

History

History
87 lines (65 loc) · 4.11 KB

README.md

File metadata and controls

87 lines (65 loc) · 4.11 KB
Raw

CS Lint Security Test Coverage Status

Equalize Digital Accessibility Checker

What is this?

Audit and check your website for accessibility before you hit publish. In-post accessibility scanner and guidance for WCAG compliance. No API or per page fees.

Want to contribute?

Prerequisites

At Equalize Digital, we make use of a specific toolset to develop our code. Please ensure you have the following tools installed before contributing.

Getting started

Check out this repository from GitHub, then run:

composer install
npm install
npm run build

Dev environment setup

This plugin uses a modified version of wp-env to support loopback: https://github.com/equalizedigital/accessibility-checker-wp-env

See also: https://developer.wordpress.org/block-editor/getting-started/devenv/get-started-with-wp-env/

To install:

  1. Install docker, node, npm, and composer
  2. If using the Pro plugin add the license key to env.txt and rename as .env
  3. run npm install

This will start a Dev server on localhost:8888 and a Tests server on localhost:8889.

By default, the Dev server maps these plugin folders if they exist:

./../accessibility-checker/
./../accessibility-checker-pro/
./../accessibility-checker-audit-history/

Package scripts

  • npm start - starts wp-env
  • npm stop - stops wp-env
  • npm run hard-reset - destroys and rebuilds wp-env
  • npm run build - builds JavaScript & CSS
  • npm run dev - watches and automatically builds JavaScript & CSS
  • npm run lint - lints the plugin's PHP and JavaScript
  • npm run lint:php - lints the plugin's PHP
  • npm run lint:php:fix - fixes linting issues in the plugin's PHP
  • npm run lint:js - lints the plugin's JavaScript
  • npm run lint:js:fix - fixes linting issues in the plugin's JavaScript
  • npm run dist - builds a distributable .zip for the plugin into ./dist
  • npm run wp:clean - resets the wp database for the Dev server
  • npm run wp:sql - opens a my-sql cli for the Dev server database
  • test:php - runs the plugin's PHP unit test
  • test:e2e - runs the plugin's End-to-End test

Support

This is a developer portal for Accessibility Checker and should not be used for support. Please visit the support forums for support.

Contributions

Anyone is welcome to contribute to Accessibility Checker. Please read the guidelines for contributing to this repository.

There are various ways you can contribute:

  • Raise an issue on GitHub.
  • Send us a Pull Request with your bug fixes and/or new features.