Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[draft] chore: list environment variables in the readme #337

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[draft] chore: list environment variables in the readme #337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,23 @@ nvm install <nodejs_version_greater_than_15>
nvm use <nodejs_version_greater_than_15>
```

#### Environment variables (Optional)
| Variable Name | Description | Default |
| ------------- | ----------- | ------- |
| PURPLE_A11Y_VERBOSE_STORAGE_PATH | Location for storing generated reports | Current working directory |
| PURPLE_A11Y_VERBOSE | When set to `true`, log output goes to console | `false` |
| RUNNING_FROM_PH_GUI | | `false` |
| REPORT_BREAKDOWN | Further breakdown reports according to their respective impact level | `false` |
| WARN_LEVEL | seems to be used as a global variable. Only used in tests. | |

#### Environment variables used internally (DO NOT SET)
| Variable Name | Description |
| ------------- | ----------- |
| CRAWLEE_LOG_LEVEL | https://crawlee.dev/docs/guides/configuration#crawlee_log_level |
| CRAWLEE_STORAGE_DIR | https://crawlee.dev/docs/guides/configuration#crawlee_storage_dir |
| CRAWLEE_HEADLESS | https://crawlee.dev/docs/guides/configuration#crawlee_headless |


#### Facing issues?

Please refer to [Troubleshooting section](#troubleshooting) for more information.
Expand All @@ -68,6 +85,7 @@ Purple A11y can perform the following to scan the target URL.

> - Windows (PowerShell): `rm "$env:APPDATA\Purple A11y\userData.txt"`
> - MacOS (Terminal): `rm "$HOME/Library/Application Support/Purple A11y/userData.txt"`
> - Linux (Terminal): `rm ~/.config/purple-ally/userData.txt`

If `userData.txt` does not exists just run `node index`.

Expand Down Expand Up @@ -208,7 +226,7 @@ Custom flow allows you to record a series of actions in the browser and re-play
Sitemap
Website
❯ Custom
```
```

1. Specify the URL of the starting page you wish to scan
2. A Chrome and Playwright Inspector window will appear. Navigate through the pages you would like to conduct an accessibility scan.
Expand Down