pa11y-dashboard is a web interface to the pa11y accessibility reporter; allowing you to focus on fixing issues rather than hunting them down.

Current Version: 1.8.2
Build Status:
Node Version Support: 0.10

pa11y-dashboard requires Node.js 0.10+, PhantomJS, and MongoDB to be installed. See the pa11y and pa11y-webservice documentation for more information on these dependencies.

You'll then need to clone this repo locally and install dependencies with npm install.

Once you have a local clone, you'll need to copy some sample configuration files in order to run the application. From within the repo, run the following commands:

$ cp config/development.sample.json config/development.json
$ cp config/production.sample.json config/production.json
$ cp config/test.sample.json config/test.json

Each of these files defines configurations for a different environment. If you're just running the application locally, then you should be OK with just development configurations. The available configurations are documented here.

Now that you've got your application configured, you can run in each mode with the following commands:

$ NODE_ENV=production node .   # Run in production
$ NODE_ENV=development node .  # Run in development
$ NODE_ENV=test node .         # Run in test

Check the development instructions for more information about running locally (and restarting automatically when files change).

The boot configurations for pa11y-dashboard are as follows. Look at the sample JSON files in the repo for example usage.

(number) The port to run the application on.

(boolean) If set to true (default), the dashboard will not be indexed by search engines. Set to false to allow indexing.

(boolean) If set to true, users will not be able to add, delete or run URLs (defaults to false).

(string) A message to display prominently on the site home page. Defaults to null.

This can either be an object containing pa11y-webservice configurations, or a string which is the base URL of a pa11y-webservice instance you are running separately.

To develop pa11y-dashboard, you'll need to clone the repo and get set up as outlined in the setup guide. You'll also need Grunt to be installed globally in order to run tests, you can do this with npm install -g grunt-cli.

Once you've done this, you'll need to start the application in test mode with:

$ grunt start-test

Now you'll be able to run the following commands:

$ grunt             # Run the lint and test tasks together
$ grunt lint        # Run JSHint with the correct config
$ grunt compile     # Compile front-end assets
$ grunt start       # Run app in development mode, restarting if files change
$ grunt start-test  # Run app in test mode, restarting if files change
$ grunt test        # Run functional tests
$ grunt watch       # Watch for file changes and compile assets

Code with lint errors or failing tests will not be accepted, please use the build tools outlined above.

For users with push-access, don't commit to the master branch. Code should be in develop until it's ready to be released.

Copyright 2013 Springer Nature.
pa11y-dashboard is licensed under the GNU General Public License 3.0.