๐Ÿ“ฆ EqualifyEverything / equalify-schema

Equalify's super simple schema for accessibility testing results.

โ˜… 2 stars โ‘‚ 0 forks ๐Ÿ‘ 2 watching โš–๏ธ Other
๐Ÿ“ฅ Clone https://github.com/EqualifyEverything/equalify-schema.git
HTTPS git clone https://github.com/EqualifyEverything/equalify-schema.git
SSH git clone git@github.com:EqualifyEverything/equalify-schema.git
CLI gh repo clone EqualifyEverything/equalify-schema
Blake Bertuccelli-Booth Blake Bertuccelli-Booth Move relatedUrlIds to node objects c2a5416 1 years ago ๐Ÿ“ History
๐Ÿ“‚ c2a54165d54101d3c8f60510ebcb4b10ede44dd6 View all commits โ†’
๐Ÿ“ .ddev
๐Ÿ“ stream-app
๐Ÿ“„ .gitignore
๐Ÿ“„ LICENSE
๐Ÿ“„ MANIFESTO.md
๐Ÿ“„ README.md
๐Ÿ“„ README.md

STREAM

Standardized Test Results for Equal Accessibility Measurement (STREAM)

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

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

STREAM simplifies the accessibility testing landscape by:

  • Preserving critical violation and success data to aid in remediation efforts.
  • Enhancing readability to ensure results are easily understood at a glance.
Equalify and participating devs are developing stream-schema.json to standardize how results are reported.

Key Benefits

  • Reduced File Size: STREAM 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 STREAM file is unique, so you see fewer redundant items like messages and tags.

Getting Started

Running the STREAM App

The STREAM app transforms accessibility test outputs into the STREAM format, ensuring compliance with stream-schema.json.

Prerequisites:

  • Node.js
  • npm
Steps:
  • Clone this repository and navigate to the stream-app directory:
cd stream-app
  • Install dependencies:
npm install
  • 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:

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

Contributing

STREAM is a standard created by hacking.

Anyone who wants to update STREAM 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?

The Web Accessibility Initiative (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!

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

Maintainers

STREAM 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: