Skip to content

Commit

Permalink
updated package and asset names from hats to a11y
Browse files Browse the repository at this point in the history
  • Loading branch information
Thumster committed Dec 7, 2023
1 parent 5cbf0d4 commit c0c82af
Show file tree
Hide file tree
Showing 20 changed files with 145 additions and 145 deletions.
30 changes: 15 additions & 15 deletions .github/workflows/image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,45 +42,45 @@ jobs:
- name: Move build to root
shell: pwsh
run: |
Move-Item "${{github.workspace}}\out\Purple HATS-win32-x64" -Destination "${{github.workspace}}\Purple HATS-win32-x64" -Force
Move-Item "${{github.workspace}}\out\Purple A11y-win32-x64" -Destination "${{github.workspace}}\Purple A11y-win32-x64" -Force
- name: Download Purple HATS Backend
- name: Download Purple A11y Backend
shell: pwsh
run: |
$PHbackendUrl = "https://github.com/GovTechSG/purple-hats/releases/download/${{ vars.BE_TAG }}/purple-hats-portable-windows.zip"
$PHbackendUrl = "https://github.com/GovTechSG/purple-hats/releases/download/${{ vars.BE_TAG }}/purple-a11y-portable-windows.zip"
$BEdestinationPath = "${{github.workspace}}\PHLatest.zip"
$BEextractPath = "D:\a\Purple HATS Backend"
$BEextractPath = "D:\a\Purple A11y Backend"
Invoke-WebRequest -Uri $PHbackendUrl -OutFile $BEdestinationPath
Expand-Archive -Path $BEdestinationPath -DestinationPath $BEextractPath -Force
Remove-Item -Path $BEdestinationPath
- name: Execute Inno Setup script to compile installer
shell: pwsh
run: ISCC /O"${{github.workspace}}" "${{github.workspace}}\hats_for_windows.iss"
run: ISCC /O"${{github.workspace}}" "${{github.workspace}}\a11y_for_windows.iss"

- name: Move compiled installer to Workspace
run: |
New-Item -Path setup -ItemType Directory
Move-Item -Path mysetup.exe -Destination setup\Purple-Hats-Setup.exe
Move-Item -Path mysetup.exe -Destination setup\Purple-A11y-Setup.exe
working-directory: ${{github.workspace}}

- name: Zip Setup file (Windows)
shell: pwsh
run: Compress-Archive -Path ${{github.workspace}}/setup/* -DestinationPath purple-hats-desktop-windows.zip
run: Compress-Archive -Path ${{github.workspace}}/setup/* -DestinationPath purple-a11y-desktop-windows.zip
working-directory: ${{github.workspace}}

- name: Upload Purple HATS Windows setup artifact
- name: Upload Purple A11y Windows setup artifact
uses: actions/upload-artifact@v3
with:
name: purple-hats-desktop-windows
path: purple-hats-desktop-windows.zip
name: purple-a11y-desktop-windows
path: purple-a11y-desktop-windows.zip

- name: Release Windows artifact
uses: softprops/action-gh-release@v1
if: startsWith(github.ref, 'refs/tags/')
with:
files: |
purple-hats-desktop-windows.zip
purple-a11y-desktop-windows.zip
mac-install-purple:
runs-on: self-hosted
Expand Down Expand Up @@ -136,18 +136,18 @@ jobs:

- name: Move and rename universal binary zip (Mac)
run: |
mv *.zip "${{github.workspace}}/purple-hats-desktop-macos.zip"
mv *.zip "${{github.workspace}}/purple-a11y-desktop-macos.zip"
working-directory: ${{github.workspace}}/out/make/zip/darwin/universal

- name: Upload Mac artifact
uses: actions/upload-artifact@v3
with:
name: purple-hats-desktop-macos
path: purple-hats-desktop-macos.zip
name: purple-a11y-desktop-macos
path: purple-a11y-desktop-macos.zip

- name: Release Mac artifact
uses: softprops/action-gh-release@v1
if: startsWith(github.ref, 'refs/tags/')
with:
files: |
purple-hats-desktop-macos.zip
purple-a11y-desktop-macos.zip
38 changes: 19 additions & 19 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
# Installation Guide

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

## About Purple HATS
## About Purple A11y

Purple HATS 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.
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 HATS Desktop can run on MacOS Big Sur or above, and a [supported](https://learn.microsoft.com/en-us/windows/release-health/supported-versions-windows-client) version of Windows 10 (64-bit) or Windows 11.
* Purple A11y Desktop can run on MacOS Big Sur or above, and a [supported](https://learn.microsoft.com/en-us/windows/release-health/supported-versions-windows-client) version of Windows 10 (64-bit) or Windows 11.
* Google Chrome browser is [installed](https://www.google.com/chrome).
* One-time Internet access is needed to download and install Purple HATS Desktop.
* You are recommended to be logged on to an admin user to run Purple HATS Desktop.
* 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

<details>
<summary>Click here for Windows setup instructions </summary>

### Download Purple HATS Desktop Windows
### Download Purple A11y Desktop Windows

* Download [purple-hats-desktop-windows.zip](https://github.com/GovTechSG/purple-hats-desktop/releases/latest/download/purple-hats-desktop-windows.zip)
* Download [purple-a11y-desktop-windows.zip](https://github.com/GovTechSG/purple-hats-desktop/releases/latest/download/purple-a11y-desktop-windows.zip)
* Double-click the downloaded zip file. Extract the contents of the zip file with a right-click and choosing “Extract All” in the context menu.

### Run Purple HATS Desktop Windows
### Run Purple A11y Desktop Windows

* Double-click the extracted Purple-Hats-Setup.exe file.
* Double-click the extracted Purple-A11y-Setup.exe file.
* If you see "Windows protected your PC" prompt as shown below, click "More info" and "Run anyway".

<img width="787" alt="Windows protected your PC prompt" src="https://github.com/GovTechSG/purple-hats-desktop/assets/2021525/6ec34301-26ce-41a5-9648-53d36e9198af">

* Follow the on-screen instructions to complete the setup process.
* Run Purple HATS Desktop from the Windows start menu.
* Purple HATS will start setting up. This process may take up to 5 minutes.
* Run Purple A11y Desktop from the Windows start menu.
* Purple A11y will start setting up. This process may take up to 5 minutes.

</details>

Expand All @@ -41,16 +41,16 @@ Purple HATS is a customisable, automated accessibility testing tool that allows
<details>
<summary>Click here for MacOS setup instructions </summary>

### Download Purple HATS desktop MacOS
### Download Purple A11y desktop MacOS

* Download [purple-hats-desktop-macos.zip](https://github.com/GovTechSG/purple-hats-desktop/releases/latest/download/purple-hats-desktop-macos.zip).
* If Purple HATS app does not appear in your Downloads folder, double-click the downloaded purple-hats-desktop-macos.zip file.
* Download [purple-a11y-desktop-macos.zip](https://github.com/GovTechSG/purple-hats-desktop/releases/latest/download/purple-a11y-desktop-macos.zip).
* If Purple A11y app does not appear in your Downloads folder, double-click the downloaded purple-a11y-desktop-macos.zip file.

> Tip: To extract files in Mac, double-click on `purple-hats-portable-mac.zip` file, usually located at your Downloads folder. A new folder with the name purple-hats-mac will appear in Finder.
> 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-mac will appear in Finder.
### Run Purple HATS Desktop MacOS
### Run Purple A11y Desktop MacOS

* Double-click Purple HATS then click "Open" in the pop-up menu.
* Purple HATS will start setting up. This process may take up to 5 minutes.
* Double-click Purple A11y then click "Open" in the pop-up menu.
* Purple A11y will start setting up. This process may take up to 5 minutes.

</details>
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Purple HATS Desktop
# Purple A11y Desktop

Purple hats Desktop is a desktop frontend for [Purple HATS](https://github.com/GovTechSG/purple-hats) accessibility site scanner - a customisable, automated web accessibility testing tool that allows software development teams to find and fix accessibility problems to improve persons with disabilities (PWDs) access to digital services.
Purple A11y Desktop is a desktop frontend for [Purple A11y](https://github.com/GovTechSG/purple-hats) accessibility site scanner - a customisable, automated web accessibility testing tool that allows software development teams to find and fix accessibility problems to improve persons with disabilities (PWDs) access to digital services.

<img alt="Purple HATS Desktop main screen" src="https://github.com/GovTechSG/purple-hats-desktop/assets/2021525/8eb8268e-80dd-4aff-b004-a4e7b8949ebc">
<img alt="Purple A11y Desktop main screen" src="https://github.com/GovTechSG/purple-hats-desktop/assets/2021525/8eb8268e-80dd-4aff-b004-a4e7b8949ebc">

## Technology Stack

Expand All @@ -11,9 +11,9 @@ Purple hats Desktop is a desktop frontend for [Purple HATS](https://github.com/G

## Prerequisites and Installations

### Download Purple HATS Desktop
### Download Purple A11y Desktop

Purple HATS Desktop is available as a download for Windows and MacOS. Refer to [Installation Guide](/INSTALLATION.md) for step-by-step instructions.
Purple A11y Desktop is available as a download for Windows and MacOS. Refer to [Installation Guide](/INSTALLATION.md) for step-by-step instructions.

#### Facing issues?

Expand All @@ -25,7 +25,7 @@ Open an [issue ticket](https://github.com/GovTechSG/purple-hats-desktop/issues)

Enter a valid URL to scan in the textbox and press the "Scan" button. The default settings will crawl your website and scan 100 pages for accessibility issues.

![Purple HATS Desktop main page](https://github.com/GovTechSG/purple-hats-desktop/assets/2021525/7d114637-6337-4f68-a8a4-a7673c4601ef)
![Purple A11y Desktop main page](https://github.com/GovTechSG/purple-hats-desktop/assets/2021525/7d114637-6337-4f68-a8a4-a7673c4601ef)

## Limit number of pages scanned

Expand All @@ -43,11 +43,11 @@ Click on the "Advanced scan options" button to configure the scan options.

#### Website Crawl

The default scan option for Purple HATS desktop. Purple HATS Desktop will crawl and scan all the links (up to page limit) within the domain in the provided URL.
The default scan option for Purple A11y desktop. Purple A11y Desktop will crawl and scan all the links (up to page limit) within the domain in the provided URL.

#### Sitemap Crawl

With sitemap crawl, provide a URL to a sitemap file (e.g. `https.domain.com/sitemap.xml`) and Purple HATS Desktop will crawl and scan all the links (up to page limit) within the domain in the provided URL.
With sitemap crawl, provide a URL to a sitemap file (e.g. `https.domain.com/sitemap.xml`) and Purple A11y Desktop will crawl and scan all the links (up to page limit) within the domain in the provided URL.

#### Custom Flow

Expand Down Expand Up @@ -197,6 +197,6 @@ For details on which accessibility scan results trigger "Must Fix" / "Good to Fi

## Additional Information on Data

Purple HATS Desktop uses third-party open-source tools that may be downloaded over the Internet during the installation process of Purple HATS. Users should be aware of the libraries used by examining `package.json`.
Purple A11y Desktop uses third-party open-source tools that may be downloaded over the Internet during the installation process of Purple A11y. Users should be aware of the libraries used by examining `package.json`.

Purple HATS Desktop may send information to the website or URL where the user chooses to initiate a Purple HATS scan. Limited user information such as e-mail address, name, and basic analytics is collected for the purpose of knowing our usage patterns better.
Purple A11y Desktop may send information to the website or URL where the user chooses to initiate a Purple A11y scan. Limited user information such as e-mail address, name, and basic analytics is collected for the purpose of knowing our usage patterns better.
4 changes: 2 additions & 2 deletions Test.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Testing

## Functional Testing
Functional testing was conducted for the happy flow of the desktop app for Purple HATS. The test cases were written using Microsoft Playwright, which is an end-to-end testing framework that has its own test runner Playwright Test.
Functional testing was conducted for the happy flow of the desktop app for Purple A11y. The test cases were written using Microsoft Playwright, which is an end-to-end testing framework that has its own test runner Playwright Test.

### How to run test cases
1. Run the following command to build the application before running the tests.
Expand All @@ -16,7 +16,7 @@ Functional testing was conducted for the happy flow of the desktop app for Purpl
npx playwright test --worker 1
```
- Parallel \
Currently, Purple HATS does not support multiple instances of the application running in parallel so running the tests in parallel will result in errors.
Currently, Purple A11y does not support multiple instances of the application running in parallel so running the tests in parallel will result in errors.

```
npx playwright test
Expand Down
26 changes: 13 additions & 13 deletions hats_for_windows.iss → a11y_for_windows.iss
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@
; (To generate a new GUID, click Tools | Generate GUID inside the IDE.)
[SETUP]
AppId={{10A741B8-E330-4DC5-A86C-7F7B8DE775A9}
AppName=Purple HATS Desktop
AppName=Purple A11y Desktop
AppVersion=0.9.0
AppVerName=Purple HATS Desktop
AppVerName=Purple A11y Desktop
AppPublisher=GovTech
AppPublisherURL=https://github.com/GovTechSG/purple-hats-desktop
AppSupportURL=https://github.com/GovTechSG/purple-hats-desktop
AppUpdatesURL=https://github.com/GovTechSG/purple-hats-desktop
DefaultDirName=C:\Program Files\Purple HATS Desktop
DefaultDirName=C:\Program Files\Purple A11y Desktop
DisableDirPage=yes
ChangesAssociations=yes
DisableProgramGroupPage=yes
; LicenseFile=Purple HATS-win32-x64\LICENSE
; LicenseFile=Purple A11y-win32-x64\LICENSE
; Uncomment the following line to run in non administrative install mode (install for current user only.)
;PrivilegesRequired=lowest
Compression=lzma
Expand All @@ -29,21 +29,21 @@ Name: "english"; MessagesFile: "compiler:Default.isl"
Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}"; Flags: unchecked

[Files]
Source: "Purple HATS-win32-x64\*"; DestDir: "\\?\{app}\Purple HATS Frontend"; Flags: ignoreversion recursesubdirs createallsubdirs
Source: "D:\a\Purple HATS Backend\*"; DestDir: "\\?\{app}\Purple HATS Backend"; Flags: ignoreversion recursesubdirs createallsubdirs
Source: "Purple A11y-win32-x64\*"; DestDir: "\\?\{app}\Purple A11y Frontend"; Flags: ignoreversion recursesubdirs createallsubdirs
Source: "D:\a\Purple A11y Backend\*"; DestDir: "\\?\{app}\Purple A11y Backend"; Flags: ignoreversion recursesubdirs createallsubdirs
; NOTE: Don't use "Flags: ignoreversion" on any shared system files

[Icons]
Name: "{autoprograms}\Purple HATS Desktop"; Filename: "{app}\Purple HATS Frontend\Purple HATS.exe"
Name: "{autodesktop}\Purple HATS Desktop"; Filename: "{app}\Purple HATS Frontend\Purple HATS.exe"; Tasks: desktopicon
Name: "{autoprograms}\Purple A11y Desktop"; Filename: "{app}\Purple A11y Frontend\Purple A11y.exe"
Name: "{autodesktop}\Purple A11y Desktop"; Filename: "{app}\Purple A11y Frontend\Purple A11y.exe"; Tasks: desktopicon

; [Run]
; Filename: "{app}\Purple HATS Frontend\Purple Hats.exe"; Description: "{cm:LaunchProgram,Purple HATS Desktop}"; Flags: nowait postinstall skipifsilent
; Filename: "{app}\Purple A11y Frontend\Purple A11y.exe"; Description: "{cm:LaunchProgram,Purple A11y Desktop}"; Flags: nowait postinstall skipifsilent

[UninstallDelete]
Type: filesandordirs; Name: "{app}\Purple HATS Frontend"
Type: filesandordirs; Name: "{app}\Purple HATS Backend"
Type: filesandordirs; Name: "{app}\Purple A11y Frontend"
Type: filesandordirs; Name: "{app}\Purple A11y Backend"

[InstallDelete]
Type: filesandordirs; Name: "{app}\Purple HATS Frontend"
Type: filesandordirs; Name: "{app}\Purple HATS Backend"
Type: filesandordirs; Name: "{app}\Purple A11y Frontend"
Type: filesandordirs; Name: "{app}\Purple A11y Backend"
4 changes: 2 additions & 2 deletions forge.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ module.exports = {
'Test.md',
'playwright-report',
'installer.ps1',
'hats_for_windows.iss',
'a11y_for_windows.iss',
'.github'
],
...(os.platform() === 'darwin' && { extraResource: ["/tmp/purple-hats-portable-mac.zip"]})
...(os.platform() === 'darwin' && { extraResource: ["/tmp/purple-a11y-portable-mac.zip"]})
},
rebuildConfig: {},
makers: [
Expand Down
18 changes: 9 additions & 9 deletions installer.ps1
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
$PHbackendUrl = "https://github.com/GovTechSG/purple-hats/releases/latest/download/purple-hats-portable-windows.zip"
$PHfrontendUrl = "https://github.com/GovTechSG/purple-hats-desktop/releases/latest/download/purple-hats-desktop-windows-prod.zip"
$PHbackendUrl = "https://github.com/GovTechSG/purple-hats/releases/latest/download/purple-a11y-portable-windows.zip"
$PHfrontendUrl = "https://github.com/GovTechSG/purple-hats-desktop/releases/latest/download/purple-a11y-desktop-windows-prod.zip"
$BEdestinationPath = "$env:APPDATA\PHLatest.zip"
$BEextractPath = "$env:APPDATA\Purple HATS Backend"
$FEdestinationPath = "$env:APPDATA\Purple HATS-win32-x64.zip"
$FEextractPath = "$env:APPDATA\Purple HATS-win32-x64"
$BEextractPath = "$env:APPDATA\Purple A11y Backend"
$FEdestinationPath = "$env:APPDATA\Purple A11y-win32-x64.zip"
$FEextractPath = "$env:APPDATA\Purple A11y-win32-x64"
$innoSetupCompilerUrl = "https://jrsoftware.org/download.php/is.exe"
$innoSetupCompilerPath = "$env:APPDATA\iscc.exe"
$current_path = (Get-Item -Path ".\" -Verbose).FullName
Expand All @@ -14,24 +14,24 @@ Expand-Archive -Path $BEdestinationPath -DestinationPath $BEextractPath -Force

Remove-Item -Path $BEdestinationPath

echo "Purple HATS Backend extracted to $BEextractPath."
echo "Purple A11y Backend extracted to $BEextractPath."

Invoke-WebRequest -Uri $PHfrontendUrl -OutFile $FEdestinationPath

Expand-Archive -Path $FEdestinationPath -DestinationPath $FEextractPath -Force

Remove-Item -Path $FEdestinationPath

echo "Purple HATS Frontend extracted to $FEextractPath."
echo "Purple A11y Frontend extracted to $FEextractPath."

# Invoke-WebRequest -Uri $innoSetupCompilerUrl -OutFile $innoSetupCompilerPath

# echo "InnoSetup compiler extracted to $innoSetupCompilerPath."

# Start-Process "$env:APPDATA\iscc.exe" -ArgumentList "/LOG /O`"$env:APPDATA" `"C:\Program Files\Purple HATS Desktop\Purple HATS Frontend\hats_for_windows.iss`"" -Wait -NoNewWindow
# Start-Process "$env:APPDATA\iscc.exe" -ArgumentList "/LOG /O`"$env:APPDATA" `"C:\Program Files\Purple A11y Desktop\Purple A11y Frontend\a11y_for_windows.iss`"" -Wait -NoNewWindow

#echo "Inno Setup compiler has been installed."

Move-Item -Path "$current_path\hats_for_windows.iss" -Destination "$env:APPDATA\hats_for_windows.iss" -Force
Move-Item -Path "$current_path\a11y_for_windows.iss" -Destination "$env:APPDATA\a11y_for_windows.iss" -Force

echo "Moved Inno Setup script from $current_path to $env:APPDATA"
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit c0c82af

Please sign in to comment.