You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-5Lines changed: 17 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,29 +20,34 @@ Oobee is available as a download for Windows and MacOS. Refer to [Installation G
20
20
### Development and Testing
21
21
22
22
#### Set Engine Version
23
+
23
24
First open terminal and navigate to the location of clone respository of Oobee.
24
25
25
26
Then export BE_TAG to set version of Oobee (engine).
26
27
27
28
```shell
28
29
export BE_TAG=0.9.48<version number>
29
30
```
31
+
30
32
#### Build Standalone App
33
+
31
34
For Mac
32
35
33
36
```shell
34
37
npm run make-mac
35
38
```
39
+
36
40
For Windows
37
41
38
42
```shell
39
43
npm run make-win
40
44
```
41
45
42
-
This will create a folder in your repository in the *out* folder.
46
+
This will create a folder in your repository in the _out_ folder.
43
47
Enter and run the Oobee.app in the newly created folder in ../out.
44
48
45
49
#### Run and Debug
50
+
46
51
Enter the code below to build Oobee.
47
52
48
53
```shell
@@ -63,10 +68,9 @@ Open an [issue ticket](https://github.com/GovTechSG/oobee-desktop/issues) for as
63
68
64
69
---
65
70
66
-
67
71
## Basic Usage
68
72
69
-
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.
73
+
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.
70
74
71
75

72
76
@@ -236,17 +240,25 @@ Defaults to screen size of iPhone 11.
236
240
Enter a custom width in pixels. Minimum width is 320px and Maximum width is 1080px.
237
241
238
242
## Report
239
-
Once a scan of the site is completed.
243
+
244
+
Once a scan of the site is completed.
240
245
241
246
A report will be downloaded into the ../Documents folder.
242
247
243
-
An Address link to report is provided. Click on the link to access the location of the report.
248
+
An Address link to report is provided. Click on the link to access the location of the report.
244
249
245
250
You can also click on the view report button to see the Accessibility Scan Results.
246
251
247
252
## Accessibility Scan Results
253
+
248
254
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).
249
255
256
+
## System Context Diagram
257
+
258
+
<imgalt="System Context Diagram for Oobee"src="https://github.com/user-attachments/assets/9e9cd59c-46e4-46e0-b4d7-efa65d2757b8">
259
+
260
+
For Oobee's backed repository and to run Oobee as a command line, please refer to [Oobee (CLI)](https://github.com/GovTechSG/oobee).
261
+
250
262
## Additional Information on Data
251
263
252
264
Oobee 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`.
0 commit comments