mirror of
https://github.com/pa11y/pa11y-dashboard.git
synced 2025-09-24 14:21:13 +00:00
Version 4.0.0
This commit is contained in:
Jose Bolos
@@ -1,5 +1,11 @@
|
||||
# Changelog
|
||||
|
||||
## 4.0.0 (2021-11-26)
|
||||
|
||||
* Update pa11y to version 6.
|
||||
* Drop support for versions of Node.js older than 12.
|
||||
* Update MongoDB Node driver from v2 to v3, which adds support for MongoDB v4 databases.
|
||||
|
||||
## 3.3.0 (2021-04-27)
|
||||
|
||||
* Add new list view to the dashboard (thanks @sangitamane)
|
||||
|
||||
22
MIGRATION.md
22
MIGRATION.md
@@ -2,12 +2,22 @@
|
||||
|
||||
Pa11y Dashboard's API changes between major versions. This is a guide to help you make the switch when this happens.
|
||||
|
||||
## Table of Contents
|
||||
## Table of contents
|
||||
|
||||
- [Migrating from 2.0 to 3.0](#migrating-from-20-to-30)
|
||||
- [Migrating from 1.0 to 2.0](#migrating-from-10-to-20)
|
||||
* [Table of contents](#table-of-contents)
|
||||
* [Migrating from 3.0 to 4.0](#migrating-from-30-to-40)
|
||||
* [Migrating from 2.0 to 3.0](#migrating-from-20-to-30)
|
||||
* [PhantomJS to Headless Chrome](#phantomjs-to-headless-chrome)
|
||||
* [Node.js Support](#nodejs-support)
|
||||
* [Miscellaneous](#miscellaneous)
|
||||
* [Migrating from 1.0 to 2.0](#migrating-from-10-to-20)
|
||||
* [Node.js Support](#nodejs-support-1)
|
||||
|
||||
## Migrating from 2.0 to 3.0
|
||||
## Migrating from 3.0 to 4.0
|
||||
|
||||
Pa11y Dashboard requires Node.js version 12 or greater. Versions 8 and 10 are not supported any more.
|
||||
|
||||
## Migrating from 2.0 to 3.0
|
||||
|
||||
### PhantomJS to Headless Chrome
|
||||
|
||||
@@ -17,13 +27,13 @@ As a result of this change, [Pa11y Dashboard's requirements](../README.md#requir
|
||||
|
||||
### Node.js Support
|
||||
|
||||
Pa11y Webservice 3 requires Node.js version 8 or greater. Versions 4 and 6 are not supported any more.
|
||||
Pa11y Dashboard 3 requires Node.js version 8 or greater. Versions 4 and 6 are not supported any more.
|
||||
|
||||
### Miscellaneous
|
||||
|
||||
The default viewport dimensions for Pa11y have been changed from `1024x768` to `1280x1024`. This could make pa11y report a different number of errors if different content appears on the page based on its width, so results obtained with v2 and v3 may not be comparable.
|
||||
|
||||
## Migrating from 1.0 to 2.0
|
||||
## Migrating from 1.0 to 2.0
|
||||
|
||||
### Node.js Support
|
||||
|
||||
|
||||
25
README.md
25
README.md
@@ -14,7 +14,9 @@ Pa11y Dashboard is a web interface to the [Pa11y][pa11y] accessibility reporter;
|
||||
|
||||
## Requirements
|
||||
|
||||
Pa11y Dashboard is a [Node.js][node] application and requires a stable or LTS version of Node, currently version 8 or greater.
|
||||
Pa11y Dashboard is a [Node.js][node] application and requires a stable or LTS version of Node, currently version 12 or 14.
|
||||
|
||||
⚠️ At the moment, Pa11y Dashboard won't work with Node.js v16. Please use Node.js 12 or 14. ⚠️
|
||||
|
||||
Pa11y Dashboard uses a [MongoDB][mongo] database to store the results of the tests. The database doesn't have to be in the same server or computer where Pa11y Dashboard is running from.
|
||||
|
||||
@@ -39,28 +41,32 @@ npm install
|
||||
|
||||
Instructions for installing and running MongoDB are outside the scope of this document. When in doubt, please refer to the [MongoDB installation instructions](https://docs.mongodb.com/manual/installation/) for details of how to install and run MongoDB on your specific operating system. An example of the installation and configuration process for macOS follows.
|
||||
|
||||
Pa11y Dashboard currently uses version `2.2` of the Node.js MongoDB driver, which means that [only MongoDB servers of versions 3.4 or older are supported](https://docs.mongodb.com/drivers/node/compatibility/). Please ensure that your MongoDB server fills the requirements before trying to run Pa11y Dashboard.
|
||||
Pa11y Dashboard currently uses version 3 of the Node.js MongoDB driver, which means that [only MongoDB servers of versions 4.4 or older are supported](https://docs.mongodb.com/drivers/node/current/compatibility/#mongodb-compatibility). Please ensure that your MongoDB server fills the requirements before trying to run Pa11y Dashboard.
|
||||
|
||||
#### Example MongoDB installation for macOS
|
||||
|
||||
On recent versions of macOS (10.13 or later), you can use [Homebrew](https://brew.sh/) to install MongoDB 3.4 Community Edition. More recent versions of MongoDB are untested and unsupported.
|
||||
On recent versions of macOS (10.13 or later), you can use [Homebrew](https://brew.sh/) to install MongoDB Community Edition. More recent versions of MongoDB are untested and unsupported.
|
||||
|
||||
Tap the MongoDB Homebrew Tap:
|
||||
|
||||
```sh
|
||||
brew tap mongodb/brew
|
||||
```
|
||||
|
||||
Install the Community version of MongoDB:
|
||||
Install a supported Community version of MongoDB:
|
||||
|
||||
```sh
|
||||
brew install mongodb-community@3.4
|
||||
brew install mongodb-community@4.4
|
||||
```
|
||||
|
||||
Start the MongoDB server:
|
||||
|
||||
```sh
|
||||
brew services start mongodb/brew/mongodb-community@3.4
|
||||
brew services start mongodb/brew/mongodb-community@4.4
|
||||
```
|
||||
|
||||
Check that the service has started properly:
|
||||
|
||||
```sh
|
||||
$ brew services list
|
||||
Name Status User Plist
|
||||
@@ -150,7 +156,7 @@ make less # Compile the site CSS from LESS files
|
||||
make uglify # Compile and uglify the client-side JavaScript
|
||||
```
|
||||
|
||||
## Useful Resources
|
||||
## Useful resources
|
||||
|
||||
* [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitalOcean](https://una.im/pa11y-dash/)
|
||||
* [Monitoring Web Accessibility Compliance With Pa11y Dashboard](https://www.lullabot.com/articles/monitoring-web-accessibility-compliance-with-pa11y-dashboard)
|
||||
@@ -163,8 +169,9 @@ We also maintain a [migration guide](MIGRATION.md) to help you migrate.
|
||||
|
||||
| :grey_question: | Major Version | Last Minor Release | Node.js Versions | Support End Date |
|
||||
| :-------------- | :------------ | :----------------- | :--------------- | :--------------- |
|
||||
| :heart: | 3 | N/A | 8+ | N/A |
|
||||
| :hourglass: | 2 | 2.4.2 | 4+ | 2020-01-16 |
|
||||
| :heart: | 4 | N/A | 12+ | N/A |
|
||||
| :hourglass: | 3 | 3.3.0 | 8+ | 2022-05-26 |
|
||||
| :skull: | 2 | 2.4.2 | 4+ | 2020-01-16 |
|
||||
| :skull: | 1 | 1.12 | 0.10–6 | 2016-12-05 |
|
||||
|
||||
If you're opening issues related to these, please mention the version that the issue relates to.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "pa11y-dashboard",
|
||||
"version": "3.3.0",
|
||||
"version": "4.0.0",
|
||||
"private": true,
|
||||
"description": "Pa11y Dashboard is a visual web interface to the Pa11y accessibility reporter",
|
||||
"keywords": [
|
||||
@@ -21,8 +21,7 @@
|
||||
"bugs": "https://github.com/pa11y/dashboard/issues",
|
||||
"license": "GPL-3.0",
|
||||
"engines": {
|
||||
"node": ">=8",
|
||||
"npm": ">=6"
|
||||
"node": ">=12 <16"
|
||||
},
|
||||
"dependencies": {
|
||||
"body-parser": "~1.19.0",
|
||||
|
||||
Reference in New Issue
Block a user