Skip to content

Latest commit

 

History

History
130 lines (106 loc) · 7.17 KB

INSTALLATION.md

File metadata and controls

130 lines (106 loc) · 7.17 KB
Raw

Installation Guide

Purple A11y is provided as a portable distribution which minimises installation steps required for Windows and Mac.

About Purple A11y

Purple A11y is a customisable, automated accessibility testing tool that allows software development teams to find and fix accessibility problems to improve persons with disabilities (PWDs) access to digital services.

System Requirements

  • Purple A11y can run on MacOS Big Sur or above, and a supported version of Windows 10 (64-bit) or Windows 11.
  • Google Chrome browser is installed.
  • One-time Internet access is needed to download and install Purple A11y Desktop.
  • You are recommended to be logged on to an admin user to run Purple A11y Desktop.

Windows

Click here for Windows setup instructions

Download Portable Copy

  • Download and extract latest purple-a11y-portable-windows.zip.
  • Tip: To extract files, right-click the Compressed zip file and click "Extract All…" in the context menu.

Run Purple A11y

  • Navigate to the folder containing purple-a11y-portable-windows.
  • Double-click a11y_shell.cmd (Windows Command Script file).
Screenshot of Windows Explorer with a11y_shell.cmd selected
  • A Windows Command Prompt window should open with contents as illustrated below. a11y_shell will automatically prepare your system to run Purple a11y.
a11y Shell - Created By younglim - NO WARRANTY PROVIDED
================================================================

INFO: Stored current working directory at C:\Users\a11y\Downloads\purple-a11y-portable-windows
INFO: Set path to node for this session
INFO: Set path to node_modules for this session
INFO: Set path to npm-global for this session
INFO: Set path to Playwright cache for this session
INFO: Set path to ImageMagick for this session
INFO: Set path to purple-a11y for this session


PS C:\Users\username\Downloads\purple-a11y-portable-windows>
  • Type in the following commands into the window. The following commands will navigate your Command Prompt window to the purple-a11y sub-directory and initiate a scan
cd purple-a11y
node index
  • If a Windows Firewall prompt appears, if you have administrator rights, click "Allow" or "Allow access". Click "Cancel" if you do not have administrator rights.
Newer Windows Firewall prompt for Allow Windows Firewall prompt for Allow access
  • You should then see your Windows Command Prompt window updated with the following contents
PS C:\Users\username\Downloads\purple-a11y-portable-windows> cd purple-a11y
PS C:\Users\username\Downloads\purple-a11y-portable-windows\purple-a11y> node index
┌────────────────────────────────────────────────────────────┐
│ Welcome to A11y Accessibility Testing Tool!                │
│ We recommend using Chrome browser for the best experience. │
│                                                            │
│ Version: ░░░░░░                                            │
└────────────────────────────────────────────────────────────┘
? What would you like to scan today? (Use arrow keys)
> sitemap
  website
  custom flow
  • Follow the steps at Features for more information on how to run a scan.

MacOS

Click here for MacOS setup instructions

Download Portable Copy

  • Download and extract purple-a11y-portable-mac.zip version.
  • Tip: To extract files in Mac, double-click on purple-a11y-portable-mac.zip file, usually located at your Downloads folder. A new folder with the name purple-a11y-portable-mac will appear in Finder.

Run Purple A11y

  • Navigate to the folder purple-a11y-portable-mac, usually located at your Downloads folder.
  • Right-click a11y_shell.command. Then click Open in the context menu.
Screenshot of right-click a11y_shell.command and Open
  • A prompt as follows will appear like below. Click Open.
MacOS prompt for unidentified developer
  • A Terminal window should open with contents as illustrated below. a11y_shell will automatically prepare your system to run Purple A11y.
Last login: Thu Mar 16 10:48:05 on ttys002
/Users/username/Downloads/purple-a11y-portable-mac/a11y_shell.command ; exit;
username@hostname ~ % /Users/username/Downloads/purple-a11y-portable-mac/a11y_shell.command ; exit;
a11y Shell - Created By younglim - NO WARRANTY PROVIDED
================================================================

INFO: Setting path to node for this session
INFO: Set path to node_modules for this session
INFO: Set path to Playwright cache for this session
INFO: Set symbolic link to ImageMagick
INFO: Set path to ImageMagick binaries
INFO: Removing com.apple.quarantine attributes for required binaries to run
username@hostname purple-a11y-portable-mac %
  • Type in the following commands into the window. The following commands will navigate your Terminal window to the purple-a11y sub-directory and initiate a scan
cd purple-a11y
node index
  • You should then see your Terminal window updated with the following contents
username@hostname purple-a11y-portable-mac % cd purple-a11y
username@hostname purple-a11y % node index
┌────────────────────────────────────────────────────────────┐
│ Welcome to A11y Accessibility Testing Tool!                │
│ We recommend using Chrome browser for the best experience. │
│                                                            │
│ Version: ░░░░░░                                            │
└────────────────────────────────────────────────────────────┘
? What would you like to scan today? (Use arrow keys)
❯ sitemap
  website
  custom flow
  • Follow the steps at Features for more information on how to run a scan.