civicactions/wai-wcag-em-report-tool

CivciActions fork of WCAG-EM Report Tool (2021 redesign)

WCAG-EM Report Tool

Preview

About this tool

The WCAG-EM Report tool is an assistant that takes the user through the process of evaluating the accessibility of a website, using the WCAG Evaluation Methodology.

It is developed by the Web Accessibility Initiative (WAI) at the World Wide Web Consortium (W3C). Initially developed with support from the WAI-ACT Project, and updated with support of the WAI-Tools Project, co-funded by the European Commission (EC).

Environments

This tool is available on:

Environment	URL(s)	Hosted at
production	w3.org/WAI/eval/report-tool	GitHub Pages of this repository
preview of main branch	https://wcag-em-report-tool-2021-redesign.netlify.app/	Netlify
previews of Pull Requests	see comment at individual Pull Request	Netlify

Local development

For local development, you will need to have Node installed.

We use Svelte so that we can express the code of this project in components and Rollup to bundle all JavaScript together.

First time

1. Clone the repository (you can fork it first)
2. In the project folder, run npm install, this gets all the Node dependencies

After first time

1. For development, run npm run dev, this builds the project, serves the application on a local server so that you can look at it and watches for any changes you make to the code
2. To only build the application, run npm run build, this builds the project without serving it.

Publishing in a sub folder

If you want to publish this tool somewhere that is not the root domain (eg w3.org/WAI/eval/report-tool instead of wcagemreporttool.com), set the BASEPATH variable before you run npm run build|dev, for example:

export BASEPATH="/WAI/eval/report-tool"

This ensures routing and paths to assets continue to work.

Contributing

If you find any problem, feel free to file an issue.

You can also add a new language, see How to add a language.