axe Watcher Examples

Running an Example

1. Set up an axe Watcher API key
2. Set up an axe Watcher project ID
3. Select an example (eg cypress/basic)
4. Install the example's dependencies

   cd cypress/basic
   npm install

5. Set your API key and project ID as environment variables, and run npm test

   API_KEY="YOUR API KEY" PROJECT_ID="YOUR PROJECT ID" npm test

6. If you are using an axe DevTools server other than axe.deque.com, specify its URL as an environment variable as well

   SERVER_URL="https://axe.yourcompany.com" API_KEY="YOUR API KEY" PROJECT_ID="YOUR PROJECT ID" npm test

Java examples

The java directory holds Maven projects built and run with mvn test instead of npm. See java/playwright for the Playwright Java examples (auto analysis, manual mode, and context wrapping) and its README for prerequisites and run instructions.