Install with Visual Studio

Link to Install with Visual Studio copied to clipboard

Leverage the integration options that exist within Visual Studio

Prerequisites

There are several prerequisites for a successful installation of axe DevTools. The page highlighting your installation options lists them.

Add a new Package Source to NuGet Sources

Installing and axe DevTools in Visual Studio requires you to extend NuGet to include Deque's Agora artifact repository.

Step 1: Open your project in Visual Studio

Step 2: Open the package source options via: Tools → Options → NuGet Package Manager → Package Sources and select + to add a new Package source:

Visual Studio showing the expanded Tools → NuGet Package Manager → Package Settings menu

Visual Studio Options panel demonstrating addition of a new Package Source

Step 3: Select the new Package Source in the Available package sources: list and then use the ... button to populate the new Package source fields:

Name: Artifactory

Source: https://agora.dequecloud.com/artifactory/api/nuget/devtools-nuget

Visual Studio Options panel demonstrating addition of a new Package Source Name and Source URL

Step 4: Select Update to save the new package source details. Select OK to dismiss the options dialog.

Add your Agora credentials to access the package source

Your Deque representative will provide you with Agora login credentials. To access your API key, log into Agora and click on the welcome banner in the top right corner. From there, you'll be able to copy your API key.

Step 5: Right click on Dependencies in the solution explorer to display the context menu and select Manage NuGet Packages:

The VS 2019 Solution Explorer displaying the open project and the open context menu showing the Dependencies → Manage NuGet Packages... selection

VS 2019 displaying the open NuGet Package Manager. The package source list is opened to display four options: all, nuget.org, Microsoft Visual Studio Offline Packages, and Artifactory. Artifactory is selected

Step 6: Select Artifactory from the package source drop-down list. The Connect to agora.dequecloud.com login modal displays. Populate the username field with the email address you used to log in to Agora and the API key you copied as the password. Check the remember my password box and select ok to complete the login process:

VS 2019 displaying the NuGet Package Manager with the package-source set to Artifactory, and the Connect to agora.dequecloud.com log-in modal populated with credentials. The Remember my password box on the log-in modal is checked.

Step 7: Switch to the browse tab when you are logged in to Artifactory. Select the axe-devtools-selenium package

VS 2019 displaying the NuGet Package Manager with Package Source set to Artifactory and the Browse tab selected. Two options display: axe-devtools-selenium, and Package.

Step 8: Select Install and then select OK to accept the preview changes listed in the modal that displays.

VS 2019 Package Manager Browser tab with the axe-devtools-selenium package and Install button selected

VS 2019 NuGet Package Manager Installation displaying Preview Changes modal and a list of install actions in the Output console. Selecting OK completes the package install and dismisses the modal

The NuGet output panel displays the installation status of the package. Expand the packages folder in the solution explorer to verify successful installation of the axe-devtools-selenium package:

VS 2019 Solution Explorer with the Packages folder expanded to show the successful installation of the axe-devtools-selenium 1.0 package into project dependencies

Step 7: Close the NugGet panel. Select your project in the solution explorer and access the context menu and select Build:

The VS Solution Explorer with the project selected and context opened to access the build command

Step 8: Select your project in the solution explorer, open the context menu, and select run tests to run all the tests in your project:

The solution explorer displayed with the context menu open and the cursor hovering over the Run Tests option.

About Visual Studio generated project files

Visual Studio generates a number of files specific to the current user upon building a project. These files are visible in the windows file explorer where the project and solution are saved. Generated files include bin and obj folders in the project folder, and a \Users\username\AppData\Roaming\NuGet\NuGet.config file. There is no need to store the generated files in source repository, especially if the new project is intended for use by multiple users to test your project.

Running Tests

Run the tests in your Visual Studio project by selecting the project name in the solution explorer and accessing the context menu to select run tests.

Is this page helpful?

Help us improve this page

Still need help?