Rename to Oobee (#118)

* Rename to oobee * style: prettier formatting * style: change hex to E55C39 * fix: animation within svg * style: change hex to 26241B * style: prettier formatting * docs: add svg * refactor: add global variables * style: prettier formatting * refactor: update new logo * style: prettier formatting * style: prettier formatting * refactor: add global variables and update a11y purple * refactor: colour changes and add new logo * refactor: update centering styles * refactor: increase height for mainWindow * chore: add oobee fonts * refactor: add variables for neutral colors, fonts, minor stylings * refactor: update oobee colours and fonts * refactor: copy updates * refactor: update oobee colour palette * refactor: update oobee colour palette for svg * refactor: update copy * refactor: update oobee colour palette * style: prettier formatting * style: prettier formatting * docs: dev notes * refactor: new homepage svg image * style: prettier * refactor: update launch window size * refactor: update oobee colour and font * chore: add new svg asset * refactor: add div container for newUpdateImg svg * refactor: update loading spinner oobee colours * refactor: update to oobee colours * style: prettier * refactor: update to oobee colours * refactor: update logo and copy * refactor: update to oobee colours * chore: add new svg asset * Fix unzip * Bump package version * Rename portable zip to oobee * Hardcode path to C:\Program Files\Oobee\ * Update text to use Oobee from Purple A11y * Update minor spelling to may from mahy * Add oobee icons * Bump package version for Oobee * Update AppId for Oobee * Fix destdir for Oobee on Windows * Fix icons for Oobee * Prevent EPIPE error when closing app * FPA * Revert image url first * chore: add PT Sans font files * fix: fonts * chore: update icon purples * chore: update readme images --------- Co-authored-by: KCas <[email protected]> Co-authored-by: Wilson WeeSheng Khoo <[email protected]>
GovTechSG · Oct 25, 2024 · bcb8d2e · bcb8d2e
1 parent 2745693
commit bcb8d2e
Show file tree

Hide file tree

Showing 72 changed files with 4,649 additions and 1,237 deletions.
diff --git a/.github/workflows/generate-release-catalog.yml b/.github/workflows/generate-release-catalog.yml
@@ -17,8 +17,8 @@ jobs:
 
     - name: Get release data
       run: |
-        LATEST_RELEASE=$(curl -s "https://api.github.com/repos/GovTechSG/purple-a11y-desktop/releases/latest")
-        ALL_RELEASES=$(curl -s "https://api.github.com/repos/GovTechSG/purple-a11y-desktop/releases")
+        LATEST_RELEASE=$(curl -s "https://api.github.com/repos/GovTechSG/oobee-desktop/releases/latest")
+        ALL_RELEASES=$(curl -s "https://api.github.com/repos/GovTechSG/oobee-desktop/releases")
         
         # Extract the latest release and pre-release tags
         LATEST_RELEASE_TAG=$(echo "$LATEST_RELEASE" | jq -r '.tag_name')

diff --git a/.github/workflows/image.yml b/.github/workflows/image.yml
@@ -32,7 +32,7 @@ jobs:
 
       - name: Install Node Modules and Build for Windows
         run: |
-          $env:Path = "${{github.workspace}}\nodejs-win;${{github.workspace}}\purple-a11y-desktop\node_modules\.bin;$env:Path;";
+          $env:Path = "${{github.workspace}}\nodejs-win;${{github.workspace}}\oobee-desktop\node_modules\.bin;$env:Path;";
           npm install
           npm run make-win
         env:
@@ -42,14 +42,14 @@ jobs:
       - name: Move build to root
         shell: pwsh
         run: |
-          Move-Item  "${{github.workspace}}\out\Purple A11y-win32-x64" -Destination "${{github.workspace}}\Purple A11y-win32-x64" -Force
+          Move-Item  "${{github.workspace}}\out\Oobee-win32-x64" -Destination "${{github.workspace}}\Oobee-win32-x64" -Force
       
-      - name: Download Purple A11y Backend
+      - name: Download Oobee Backend
         shell: pwsh
         run: |
-          $PHbackendUrl = "https://github.com/GovTechSG/purple-a11y/releases/download/${{ vars.BE_TAG }}/purple-a11y-portable-windows.zip"
+          $PHbackendUrl = "https://github.com/GovTechSG/oobee/releases/download/${{ vars.BE_TAG }}/oobee-portable-windows.zip"
           $BEdestinationPath = "${{github.workspace}}\PHLatest.zip"
-          $BEextractPath = "D:\a\Purple A11y Backend"
+          $BEextractPath = "D:\a\Oobee Backend"
           Invoke-WebRequest -Uri $PHbackendUrl -OutFile $BEdestinationPath
           Expand-Archive -Path $BEdestinationPath -DestinationPath $BEextractPath -Force
           Remove-Item -Path $BEdestinationPath
@@ -61,26 +61,26 @@ jobs:
       - name: Move compiled installer to Workspace
         run: |
           New-Item -Path setup -ItemType Directory
-          Move-Item -Path mysetup.exe -Destination setup\Purple-A11y-Setup.exe
+          Move-Item -Path mysetup.exe -Destination setup\Oobee-setup.exe
         working-directory: ${{github.workspace}}
 
       - name: Zip Setup file (Windows)
         shell: pwsh
-        run: Compress-Archive -Path ${{github.workspace}}/setup/* -DestinationPath purple-a11y-desktop-windows.zip
+        run: Compress-Archive -Path ${{github.workspace}}/setup/* -DestinationPath oobee-desktop-windows.zip
         working-directory: ${{github.workspace}}
 
-      - name: Upload Purple A11y Windows setup artifact
+      - name: Upload Oobee Windows setup artifact
         uses: actions/upload-artifact@v3
         with:
-          name: purple-a11y-desktop-windows
-          path: purple-a11y-desktop-windows.zip
+          name: oobee-desktop-windows
+          path: oobee-desktop-windows.zip
 
       - name: Release Windows artifact
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
-            purple-a11y-desktop-windows.zip
+            oobee-desktop-windows.zip
             
   mac-install-purple:
     runs-on: self-hosted
@@ -117,7 +117,7 @@ jobs:
             export PATH_TO_NODE="${{github.workspace}}/nodejs-mac-x64/bin"
           fi
           export PATH="$PATH_TO_NODE:$PATH"
-          export PATH="$PWD/purple-a11y-desktop/node_modules/.bin:$PATH"
+          export PATH="$PWD/oobee-desktop/node_modules/.bin:$PATH"
         env:
           CI: ""
         working-directory: ${{github.workspace}}
@@ -136,18 +136,18 @@ jobs:
 
       - name: Move and rename universal binary zip (Mac)
         run: |
-          mv *.zip "${{github.workspace}}/purple-a11y-desktop-macos.zip"
+          mv *.zip "${{github.workspace}}/oobee-desktop-macos.zip"
         working-directory: ${{github.workspace}}/out/make/zip/darwin/universal
 
       - name: Upload Mac artifact
         uses: actions/upload-artifact@v3
         with:
-          name: purple-a11y-desktop-macos
-          path: purple-a11y-desktop-macos.zip
+          name: oobee-desktop-macos
+          path: oobee-desktop-macos.zip
 
       - name: Release Mac artifact
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
-            purple-a11y-desktop-macos.zip
+            oobee-desktop-macos.zip
diff --git a/INSTALLATION.md b/INSTALLATION.md
@@ -1,42 +1,42 @@
 # Installation Guide
 
-Purple A11y desktop is provided as a portable distribution which minimises installation steps required for Windows and Mac.
+Oobee Desktop is provided as a portable distribution which minimises installation steps required for Windows and Mac.
 
-## About Purple A11y
+## About Oobee
 
-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.
+Oobee 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 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.
+* Oobee 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 A11y Desktop.
-* You are recommended to be logged on to an admin user to run Purple A11y Desktop.
+* One-time Internet access is needed to download and install Oobee Desktop.
+* You are recommended to be logged on to an admin user to run Oobee Desktop.
 
 ## Windows
 
 <details>
     <summary>Click here for Windows setup instructions </summary>
 
-### Download Purple A11y Desktop Windows
+### Download Oobee Desktop Windows
 
-* Download [purple-a11y-desktop-windows.zip](https://github.com/GovTechSG/purple-a11y-desktop/releases/latest/download/purple-a11y-desktop-windows.zip)
+* Download [oobee-desktop-windows.zip](https://github.com/GovTechSG/oobee-desktop/releases/latest/download/oobee-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 A11y Desktop Windows
+### Run Oobee Desktop Windows
 
-* Double-click the extracted Purple-A11y-Setup.exe file.
+* Double-click the extracted Oobee-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-a11y-desktop/assets/2021525/6ec34301-26ce-41a5-9648-53d36e9198af">
+    <img width="787" alt="Windows protected your PC prompt" src="https://github.com/GovTechSG/oobee-desktop/assets/2021525/6ec34301-26ce-41a5-9648-53d36e9198af">
 
 * Follow the on-screen instructions to complete the setup process.
-* Run Purple A11y Desktop from the Windows start menu.
-* Purple A11y will start setting up. This process may take up to 5 minutes.
+* Run Oobee Desktop from the Windows start menu.
+* Oobee will start setting up. This process may take up to 5 minutes.
 
  * 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.
 
-    <img width="261" alt="Newer Windows Firewall prompt for Allow" src="https://github.com/GovTechSG/purple-a11y/assets/50561219/4ece401b-1195-4a90-a327-243c081690b9"> <img width="331" alt="Windows Firewall prompt for Allow access" src="https://github.com/GovTechSG/purple-a11y/assets/2021525/d6d435c4-f534-4416-b418-a8b8e15f3b3f">
+    <img width="261" alt="Newer Windows Firewall prompt for Allow" src="https://github.com/GovTechSG/oobee/assets/50561219/4ece401b-1195-4a90-a327-243c081690b9"> <img width="331" alt="Windows Firewall prompt for Allow access" src="https://github.com/GovTechSG/oobee/assets/2021525/d6d435c4-f534-4416-b418-a8b8e15f3b3f">
 
 </details>
 
@@ -45,16 +45,16 @@ Purple A11y is a customisable, automated accessibility testing tool that allows
 <details>
     <summary>Click here for MacOS setup instructions </summary>
 
-### Download Purple A11y desktop MacOS
+### Download Oobee Desktop MacOS
 
-* Download [purple-a11y-desktop-macos.zip](https://github.com/GovTechSG/purple-a11y-desktop/releases/latest/download/purple-a11y-desktop-macos.zip).
-* If Purple A11y app does not appear in your Downloads folder, double-click the Purple A11y file.
+* Download [oobee-desktop-macos.zip](https://github.com/GovTechSG/oobee-desktop/releases/latest/download/oobee-desktop-macos.zip).
+* If Oobee app does not appear in your Downloads folder, double-click the Oobee file.
 
-> Tip: To extract files in Mac, double-click on `purple-a11y-desktop-macos.zip` file, which is usually saved to your Downloads folder. A new app `Purple A11y` with the a11y icon will appear.  Drag or move `Purple A11y` app to your Applications folder for easy access.
+> Tip: To extract files in Mac, double-click on `oobee-desktop-macos.zip` file, which is usually saved to your Downloads folder. A new app `Oobee` with the a11y icon will appear.  Drag or move `Oobee` app to your Applications folder for easy access.
 
-### Run Purple A11y Desktop MacOS
+### Run Oobee Desktop MacOS
 
-* 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.
+* Double-click Oobee then click "Open" in the pop-up menu.
+* Oobee will start setting up. This process may take up to 5 minutes.
 
 </details>
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# Purple A11y Desktop
+# Oobee Desktop
 
-Purple A11y Desktop is a desktop frontend for [Purple A11y](https://github.com/GovTechSG/purple-a11y) an 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. The official application can only be downloaded at [https://go.gov.sg/get-purplea11y](https://go.gov.sg/get-purplea11y). We recommend that you download the software only from the official link, as other sources and/or third party links may pose risks and/or compromise your system.
+Oobee Desktop (formerly known as Purple A11y) is a desktop frontend for [Oobee](https://github.com/GovTechSG/oobee) an 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. The official application can only be downloaded at [https://go.gov.sg/get-purplea11y](https://go.gov.sg/get-purplea11y). We recommend that you download the software only from the official link, as other sources and/or third party links may pose risks and/or compromise your system.
 
-<img alt="Purple A11y Desktop main screen" src="https://github.com/GovTechSG/purple-a11y-desktop/assets/2021525/8eb8268e-80dd-4aff-b004-a4e7b8949ebc">
+<img alt="Oobee Desktop main screen" src="https://github.com/user-attachments/assets/3992115c-d237-4d66-b247-a541a2a49f9e">
 
 ## Technology Stack
 
@@ -11,16 +11,16 @@ Purple A11y Desktop is a desktop frontend for [Purple A11y](https://github.com/G
 
 ## Installations
 
-### Download Purple A11y Desktop
+### Download Oobee Desktop
 
-Purple A11y Desktop is available as a download for Windows and MacOS. Refer to [Installation Guide](/INSTALLATION.md) for step-by-step instructions.
+Oobee Desktop is available as a download for Windows and MacOS. Refer to [Installation Guide](/INSTALLATION.md) for step-by-step instructions.
 
 ### Development and Testing
 
 #### Set Engine Version
-First open terminal and navigate to the location of clone respository of Purple A11y Desktop.
+First open terminal and navigate to the location of clone respository of Oobee Desktop.
 
-Then export BE_TAG to set version of Purple A11y (engine).
+Then export BE_TAG to set version of Oobee (engine).
 
 ```shell
 export BE_TAG=0.9.48<version number>
@@ -38,26 +38,26 @@ npm run make-win
 ```
 
 This will create a folder in your repository in the *out* folder.
-Enter and run the Purple Ally.app in the newly created folder in ../out.
+Enter and run the Oobee.app in the newly created folder in ../out.
 
 #### Run and Debug
-Enter the code below to build Purple A11y Desktop.
+Enter the code below to build Oobee Desktop.
 
 ```shell
 npm run build
 ```
 
-Finally to start Purple A11y Desktop enter the code below.
+Finally to start Oobee Desktop enter the code below.
 
 ```shell
 npm run start
 ```
 
-An application window should be open with the inserted version. You mahy debug the app through Terminal / PowerShell window.
+An application window should be open with the inserted version. You may debug the app through Terminal / PowerShell window.
 
 #### Facing issues?
 
-Open an [issue ticket](https://github.com/GovTechSG/purple-a11y-desktop/issues) for assistance.
+Open an [issue ticket](https://github.com/GovTechSG/oobee-desktop/issues) for assistance.
 
 ---
 
@@ -66,29 +66,29 @@ Open an [issue ticket](https://github.com/GovTechSG/purple-a11y-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 A11y Desktop main page](https://github.com/GovTechSG/purple-a11y-desktop/assets/2021525/7d114637-6337-4f68-a8a4-a7673c4601ef)
+![Oobee Desktop main page](https://github.com/user-attachments/assets/94d19cf8-88e4-46c3-b5d6-647b7c615a6e)
 
 ## Limiting pages scanned
 
 If you find a scan takes too long to complete due to large website, or there are too many pages in a sitemap to scan, you may choose to limit number of pages scanned. Click on the drop down and enter the desired number of pages to scan.
 
-![Limit Scan Pages](https://github.com/GovTechSG/purple-a11y-desktop/assets/2021525/4bfb1125-138e-4720-9db0-a046a4b1f495)
+![Limit Scan Pages](https://github.com/user-attachments/assets/b0180bd4-bd98-44f8-a8ea-9f73f29b7538)
 
 ## Advanced scan options
 
 Click on the "Advanced scan options" button to configure the scan options.
 
-![Advanced Scan Options](https://github.com/GovTechSG/purple-a11y-desktop/assets/2021525/caf2c1a6-1acf-433d-9843-3482666ac377)
+![Advanced Scan Options](https://github.com/user-attachments/assets/58bbbf47-30f6-4751-bbb8-b8d6243f5187)
 
 ### Scan Type Selection
 
 #### Website Crawl
 
-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.
+The default scan option for Oobee Desktop. Oobee 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 A11y 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 Oobee Desktop will crawl and scan all the links (up to page limit) within the domain in the provided URL.
 
 #### Custom Flow
 
@@ -243,10 +243,10 @@ An Address link to report is provided. Click on the link to access the location
 You can also click on the view report button to see the Accessibility Scan Results.
 
 ## Accessibility Scan Results
-For details on which accessibility scan results trigger "Must Fix" / "Good to Fix" findings, you may refer to [Scan Issue Details](https://github.com/GovTechSG/purple-a11y/blob/master/DETAILS.md).
+For details on which accessibility scan results trigger "Must Fix" / "Good to Fix" findings, you may refer to [Scan Issue Details](https://github.com/GovTechSG/oobee/blob/master/DETAILS.md).
 
 ## Additional Information on Data
 
-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`.
+Oobee Desktop uses third-party open-source tools that may be downloaded over the Internet during the installation process of Oobee. Users should be aware of the libraries used by examining `package.json`.
 
-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.
+Oobee Desktop may send information to the website or URL where the user chooses to initiate a Oobee scan. Limited user information such as e-mail address, name, and basic analytics is collected for the purpose of knowing our usage patterns better.
diff --git a/Test.md b/Test.md
@@ -1,7 +1,7 @@
 # Testing 
 
 ## Functional Testing 
-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. 
+Functional testing was conducted for the happy flow of the desktop app for Oobee. 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. 
@@ -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 A11y does not support multiple instances of the application running in parallel so running the tests in parallel will result in errors. 
+Currently, Oobee does not support multiple instances of the application running in parallel so running the tests in parallel will result in errors. 
 
 ```
    npx playwright test