mirror of
https://github.com/pa11y/pa11y-dashboard.git
synced 2025-09-25 06:41:21 +00:00
Compare commits
14 Commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
1723472b93 | ||
![]() |
f8f1e8c15d | ||
![]() |
95869aae56 | ||
![]() |
83d8503ef6 | ||
![]() |
1e5e310b4e | ||
![]() |
7e8d6b122b | ||
![]() |
a2e7e1ffc4 | ||
![]() |
feacb2601d | ||
![]() |
358278ad00 | ||
![]() |
a94a9ed465 | ||
![]() |
0918403876 | ||
![]() |
e7b7792f89 | ||
![]() |
46b2fcd3af | ||
![]() |
c298668b76 |
21
README.md
21
README.md
@@ -3,7 +3,7 @@ pa11y-dashboard
|
|||||||
|
|
||||||
pa11y-dashboard is a web interface to the [pa11y][pa11y] accessibility reporter; allowing you to focus on *fixing* issues rather than hunting them down.
|
pa11y-dashboard is a web interface to the [pa11y][pa11y] accessibility reporter; allowing you to focus on *fixing* issues rather than hunting them down.
|
||||||
|
|
||||||
**Current Version:** *1.9.0*
|
**Current Version:** *1.10.0*
|
||||||
**Build Status:** [![Build Status][travis-img]][travis]
|
**Build Status:** [![Build Status][travis-img]][travis]
|
||||||
**Node Version Support:** *0.10*
|
**Node Version Support:** *0.10*
|
||||||
|
|
||||||
@@ -15,7 +15,9 @@ pa11y-dashboard is a web interface to the [pa11y][pa11y] accessibility reporter;
|
|||||||
Setup
|
Setup
|
||||||
-----
|
-----
|
||||||
|
|
||||||
pa11y-dashboard requires [Node.js][node] 0.10+, [PhantomJS][phantom], and [MongoDB][mongo] to be installed. See the [pa11y][pa11y] and [pa11y-webservice][pa11y-webservice] documentation for more information on these dependencies.
|
pa11y-dashboard requires [Node.js][node] 0.10+ and [PhantomJS][phantom]. See the [pa11y][pa11y] documentation for detailed instructions on how to install these dependencies on your operating system.
|
||||||
|
|
||||||
|
You'll also need to have [MongoDB][mongo] installed and running. See the [MongoDB install guide][mongo-install] for more information on this.
|
||||||
|
|
||||||
You'll then need to clone this repo locally and install dependencies with `npm install`.
|
You'll then need to clone this repo locally and install dependencies with `npm install`.
|
||||||
|
|
||||||
@@ -29,7 +31,7 @@ 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](#configurations).
|
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](#configurations).
|
||||||
|
|
||||||
Now that you've got your application configured, you can run in each mode with the following commands:
|
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:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
NODE_ENV=production node index.js # Run in production
|
NODE_ENV=production node index.js # Run in production
|
||||||
@@ -85,25 +87,32 @@ Code with lint errors or failing tests will not be accepted, please use the buil
|
|||||||
To compile the client-side JavaScript and CSS, you'll need the following commands. Compiled code is committed to the repository.
|
To compile the client-side JavaScript and CSS, you'll need the following commands. Compiled code is committed to the repository.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
make css # Compile the site CSS from LESS files
|
make less # Compile the site CSS from LESS files
|
||||||
make uglify # Compile and uglify the client-side JavaScript
|
make uglify # Compile and uglify the client-side JavaScript
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Useful Resources
|
||||||
|
-------
|
||||||
|
* [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitialOcean][resource-una-k]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
License
|
License
|
||||||
-------
|
-------
|
||||||
|
|
||||||
[Copyright 2013 Springer Nature](LICENSE.txt).
|
[Copyright 2016 Springer Nature](LICENSE.txt).
|
||||||
pa11y-dashboard is licensed under the [GNU General Public License 3.0][gpl].
|
pa11y-dashboard is licensed under the [GNU General Public License 3.0][gpl].
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[gpl]: http://www.gnu.org/licenses/gpl-3.0.html
|
[gpl]: http://www.gnu.org/licenses/gpl-3.0.html
|
||||||
[mongo]: http://www.mongodb.org/
|
[mongo]: http://www.mongodb.org/
|
||||||
|
[mongo-install]: https://docs.mongodb.org/manual/installation/
|
||||||
[node]: http://nodejs.org/
|
[node]: http://nodejs.org/
|
||||||
[pa11y]: https://github.com/springernature/pa11y
|
[pa11y]: https://github.com/springernature/pa11y
|
||||||
[pa11y-webservice]: https://github.com/springernature/pa11y-webservice
|
|
||||||
[pa11y-webservice-config]: https://github.com/springernature/pa11y-webservice#configurations
|
[pa11y-webservice-config]: https://github.com/springernature/pa11y-webservice#configurations
|
||||||
[phantom]: http://phantomjs.org/
|
[phantom]: http://phantomjs.org/
|
||||||
|
[resource-una-k]: https://una.im/pa11y-dash/
|
||||||
[travis]: https://travis-ci.org/springernature/pa11y-dashboard
|
[travis]: https://travis-ci.org/springernature/pa11y-dashboard
|
||||||
[travis-img]: https://travis-ci.org/springernature/pa11y-dashboard.png?branch=master
|
[travis-img]: https://travis-ci.org/springernature/pa11y-dashboard.png?branch=master
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "pa11y-dashboard",
|
"name": "pa11y-dashboard",
|
||||||
"version": "1.9.0",
|
"version": "1.10.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
|
||||||
"description": "pa11y-dashboard is a visual web interface to the pa11y accessibility reporter",
|
"description": "pa11y-dashboard is a visual web interface to the pa11y accessibility reporter",
|
||||||
|
@@ -20,7 +20,7 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
|
|||||||
|
|
||||||
<div class="clearfix">
|
<div class="clearfix">
|
||||||
<div class="col-md-6 col-md-offset-3 filter-toggle no-js-hide text-center">
|
<div class="col-md-6 col-md-offset-3 filter-toggle no-js-hide text-center">
|
||||||
<label for="filter-input" class="filter-trigger" data-toggle="collapse" data-target="#filter-input">Filter<span class="glyphicon glyphicon-filter"></span>
|
<label for="task-filter" class="filter-trigger" data-toggle="collapse" data-target="#filter-input">Filter<span class="glyphicon glyphicon-filter"></span>
|
||||||
</label>
|
</label>
|
||||||
<div id="filter-input" class="collapse">
|
<div id="filter-input" class="collapse">
|
||||||
<input class="form-control" id="task-filter" type="text" data-role="input" placeholder="Type filter term (name or standard)"/>
|
<input class="form-control" id="task-filter" type="text" data-role="input" placeholder="Type filter term (name or standard)"/>
|
||||||
|
@@ -19,7 +19,7 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
|
|||||||
<div class="row clearfix">
|
<div class="row clearfix">
|
||||||
<div class="col-md-12">
|
<div class="col-md-12">
|
||||||
<h1 class="h2 crunch-top">{{task.name}}</h1>
|
<h1 class="h2 crunch-top">{{task.name}}</h1>
|
||||||
<p class="h4">{{simplify-url task.url}}<span class="h5"> ({{task.standard}})</span></p>
|
<p class="h4"><a href="{{task.url}}">{{simplify-url task.url}}</a><span class="h5"> ({{task.standard}})</span></p>
|
||||||
</div>
|
</div>
|
||||||
<div class="run-details task-header clearfix">
|
<div class="run-details task-header clearfix">
|
||||||
<div class="col-md-12 clearfix">
|
<div class="col-md-12 clearfix">
|
||||||
|
Reference in New Issue
Block a user