fffunction / pa11y-dashboard

pa11y-dashboard is a web interface which helps you monitor the accessibility of your websites

pa11y-dashboard

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.10.0
Build Status:
Node Version Support: 0.10

---

✨ 🔜 ✨ The Pa11y team is very excited to announce plans for the successor to pa11y-dashboard and pa11y-webservice, codename "Sidekick". Help us define the features that you want to see by visiting the proposal. ✨

---

Setup

pa11y-dashboard requires Node.js 0.10+ and PhantomJS. See the pa11y documentation for detailed instructions on how to install these dependencies on your operating system.

You'll also need to have MongoDB installed and running. See the MongoDB install guide for more information on this.

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, make sure you have a server running with the mongod command in another terminal window. You can then run in each mode with the following commands:

NODE_ENV=production node index.js   # Run in production
NODE_ENV=development node index.js  # Run in development
NODE_ENV=test node index.js         # Run in test

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

Configurations

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

port

(number) The port to run the application on.

noindex

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

readonly

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

siteMessage

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

webservice

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

Development

To develop pa11y-dashboard, you'll need to clone the repo and get set up as outlined in the setup guide.

You'll need to start the application in test mode with:

NODE_ENV=test node index.js

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

make       # Run the lint and test tasks together
make lint  # Run linters with the correct config
make test  # Run integration tests

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

To compile the client-side JavaScript and CSS, you'll need the following commands. Compiled code is committed to the repository.

make less    # Compile the site CSS from LESS files
make uglify  # Compile and uglify the client-side JavaScript

Useful Resources

• Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitialOcean

License

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