README.md

accessibility-checker-extension

A web browser extensions that adds automated accessibility checking capabilities

Getting started

• Node Version 12.

Install dependencies

1. Under the root directory equal-access directory

   npm install
   

2. Under the accessibility-checker-extension directory

   npm install
   

3. Go back to the root directory cd ..

4. Under the report-react directory

   npm install
   npm start
   

5. On a new command line window, navigate to the accessibility-checker-extension directory and execute

   npm run build:watch:local
   

   Build run options:
   Build for dev: npm run build:dev
   Build for dev and watch for changes: npm run build:watch
   Build for production: npm run build:prod
   

Loading into the browser:

In Chrome web browser

1. Go to: chrome://extensions
2. Toggle: "developer mode" on.
3. Click on: "Load unpacked"
4. Select the newly created folder "dist" equal-access/accessibility-checker-extension/dist from the project folder.

In Firefox web browser

1. Go to: about:debugging in the Firefox browser
2. Select: "This Firefox"
3. Click on: "Load Temporary Add-on…"
4. Open the newly created folder "dist" from the project folder, and choose the "manifest.json" file.

Build the deployment package for Chrome and Firefox browsers:

npm run clean:all
npm install
npm run package:browser

The commands generate a package/accessibility-checker-extension.zip file. The zip package can be deployed into the Chrome or Firefox store. You can test the package locally in the Firefox browser (though not in the Chrome browser):

1. Go to: about:debugging in the Firefox browser
2. Select: "This Firefox"
3. Click on: "Load Temporary Add-on…"
4. Open the newly created package file "accessibility-checker-extension.zip" from the package folder.

Bugs and Issues

All bugs or issues related to the karma-accessibility-checker code can be created in GitHub Issues.