2.1 KiB
pa11y-dashboard
pa11y-dashboard is a visual web interface to the pa11y accessibility reporter.
Current Version: 1.0.0-beta.1
Node Version Support: 0.10
Setup
pa11y-dashboard requires Node.js 0.10+ and pa11y-webservice to be installed and running. You'll need to follow the setup guide for pa11y-webservice before setting up pa11y-dashboard.
You'll then need to clone this repo locally and install dependencies with make deps, this installs npm and bower dependencies. 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
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:
$ make start # start in production mode
$ make start-dev # start in development mode
Development mode runs the application with Supervisor, so you won't need to restart it if you change any JavaScript files.
Configurations
The boot configurations for pa11y-dashboard are as follows. Look at the sample JSON files in the repo for example usage.
webservice
(string) The base URL of the pa11y-webservice instance you intend on using.
port
(number) The port to run the application on.
License
Copyright 2013 Nature Publishing Group.
pa11y-dashboard is licensed under the GNU General Public License 3.0.