Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 3.97 KB

README.md

File metadata and controls

85 lines (64 loc) · 3.97 KB
Raw

Equalify Schema

A Super Simple Data Schema By Equalify

Problem

Accessibility test results are formatted in lots of different ways. That means we have to reformat the results into a standard format that has to be constantly updated when scans change. That work costs valuable time as we try to build new tools that integrate with scans. Existing standardized schemas, including EARL, are hard to understand and not widely adopted.

Our Solution

Equalify Schema standardizes accessibility test results into a format that's both human-readable and comprehensive, making it easier to identify and rectify accessibility issues.

Equalify and participating devs are developing [equalify-schema.json](https://github.com/EqualifyEverything/Equalify Schema/blob/main/equalify-schema/equalify-schema.json) to standardize how results are reported.

Key Benefits

  • Reduced File Size: The Equalify Schema reformats complex data into a simple structure that reduces redundancy.
  • Faster Processing: Smaller file sizes with a simple structure mean reduced processing time.
  • Reduced Redundancy: All content in a schema file is unique, so you see fewer redundant items like messages and tags.

Getting Started

Running the Equalify Schema App

The Equalify Schema app transforms accessibility test outputs into the Equalify Schema format, ensuring compliance with [equalify-schema.json](https://github.com/EqualifyEverything/Equalify Schema/blob/main/equalify-schema/equalify-schema.json).

Prerequisites:

  • Node.js
  • npm

Steps:

  1. Clone this repository and navigate to the equalify-schema-app directory:
cd equalify-schema-app
  1. Install dependencies:
npm install
  1. Launch the server:
node server.js

Using the API

The app's functionality is exposed through an API, enabling the reformatting of test results via HTTP requests.

With curl:

curl -X POST http://localhost:3000/api/reformat
-H "Content-Type: application/json"
-d '[Your JSON data here]'

With Postman:

  1. Set the request type to POST.
  2. Use the URL http://localhost:3000/api/reformat.
  3. Input your JSON data in the request's "Body" section (set to raw).
  4. Click 'Send'.

Contributing

Equalify Schema is a standard created by hacking.

Anyone who wants to update the Equalify Schema can. If you've identified a bug or have a suggestion, please fork this repository, make your changes, and submit a pull request.

Areas of Interest:

  • Bug fixes
  • Support for new scans

Why aren't we working with WAI?

This schema has the potential to replace EARL, maintained by The Web Accessibility Initiative (WAI).

WAI is an awesome organization building accessibility policy.

Unfortunately, Equalify can't afford to participate in the policy-building processes that WAI encourages. Equalify is a small organization trying to do big things, and we only have so much time!

Equalify Schema is built to address the immediate needs of Equalify and contributors who want to join the development. As we find technical challenges, we update Equalify Schema. Maybe at CSUN 2025, we'll present a paper showing the problems and solutions that Equalify Schema addresses. We welcome anyone working with WAI to take our project into something like a new version of EARL.

Maintainers

Equalify Schema is maintained by Equalify. Anyone else is welcome to contribute.

Interested in becoming a maintainer? Submit a PR with your name in this section to join the cause.

Support Equalify

Equalify is a community-driven initiative to build Open Source web accessibility tools.

Three easy ways to support us: