Install axe DevTools for Web for WebDriverJS from Deque's Agora

For customers who do not have an internal artifact repository and desire a more sustainable and scalable solution for installation than directly downloading axe DevTools, Deque makes its own artifact repository available to select customers. For information on other ways to install axe DevTools, see the guide on Installing from your Artifact Repository or downloading a demo project.

Prerequisites

In order to install axe DevTools from Agora, you must have Agora login credentials. Additionally, you must have an existing NodeJS based web project to install axe DevTools within, as well as WebDriverJS. Depending on the configuration of your testing environment, your testing library may be required as an additional dependency.

Accessing Your API Key

The simplest way to access your API key is through the Agora webapp. Once logged in, you can find yor API key by clicking on the button labeled "Welcome <your-email-address>" in the top bar next to the help button. From there you can copy your API key.

Adding Authentication

To access axe DevTools packages through NPM or Yarn, you will need to add your Agora authentication information to a ~/.npmrc file. The simplest way to do this is with a curl command.

curl -u"<your-email>":<your-api-key> "https://agora.dequecloud.com/artifactory/api/npm/auth"

When executing this command, replace with your Agora login email, and replace with the api key you copied in the previous step. The return of the command should look like this:

_auth = <generated-auth-string>
always-auth = true
email = <your-email>

Setting up your .npmrc file (yarn/npm)

Open your ~/.npmrc file for editing. Add the registry information first, then add the output from the curl command. The final product should look like this:

@axe-devtools:registry=https://agora.dequecloud.com/artifactory/api/npm/devtools-npm/
//agora.dequecloud.com/artifactory/api/npm/devtools-npm/:_auth=<generated-auth-string>
//agora.dequecloud.com/artifactory/api/npm/devtools-npm/:email=<your-email@email.com>
//agora.dequecloud.com/artifactory/api/npm/devtools-npm/:always-auth=true

Setting up your .yarnrc.yml file (yarn modern)

Open your ~/.yarnrc.yml file for editing. Add the registry information first, then add the output from the curl command. The final product should look like this:

npmScopes:
  axe-devtools:
      npmRegistries: 'https://agora.dequecloud.com/artifactory/api/npm/dequelabs/':
      npmAuthIdent: <generated-auth-string>
      npmRegistryServer: 'https://agora.dequecloud.com/artifactory/api/npm/dequelabs/'
      npmAlwaysAuth: true

If you are unable to execute curl commands, you can generate your auth string by base-64 encoding <your-email>:<your-api-key> and adding the product to the ~/.npmrc file the same way as if were generated with the curl command.

Installing

To install axe DevTools WebdriverJS in your project, run this command:

npm install @axe-devtools/webdriverjs

Next Steps

Once axe DevTools has been successfully installed in your environment, read the guide on importing and initializing.

If you have issues installing axe DevTools, contact your Deque representative directly, ask us via our support desk, or send us an email. We'll be happy to help you get up and running.