Create a New axe Developer Hub Project
A step-by-step guide to creating a new project in axe Developer Hub
This article shows you how to create a new project in axe Developer Hub.
1. Visit the Projects Page
On the axe website , you'll see the Products page, similar to the following:
You should see a panel for axe Developer Hub. If you do not, you can start a free trial. See Get Started Using axe Developer Hub for more information.
2. Navigate to the axe Developer Hub Projects Page
Click on the axe Developer Hub Home link to see the axe Developer Hub Projects page. You will see a page similar to the following:
3. Add a New Project
Click the + Add new project button to create a new axe Developer Hub project. You will see the following page:
4. Select the Browser Automation Platform
Choose one of the browser automation platforms.
For more information about the platforms, see the following websites:
5. Enter the Project Name
After you've chosen a browser automation platform, you need to provide a project name. You can type the name in the Project name text box and then click Next as shown below:
If you are not logged in (Sign In appears in the upper right on this page if this is the case), you will be prompted to create a new axe Account after you click Next. If you have an account, click on Sign In in the upper right and sign in to avoid the prompts to create a new account.
See Create an axe Account for a walkthrough for creating a new axe Account.
6. Copy the API Key and Modify your Test Suite
After clicking Next, you are presented with your project's API key and instructions and code snippets for adding accessibility testing to your test infrastructure. How to use the code snippets is described along with each snippet, and you can click on the copy icon to copy that snippet to the clipboard.
An example of this information is shown below:
If you'd like to re-review the instructions later, you can return to your projects page and click on the button to re-review the project's instructions. See Re-review axe Developer Hub's Instructions.
7. Run Your Test Suite
Run your test suite to collect information about accessibility defects and Git information.
8. Check Your Code's Accessibility Issues in axe Developer Hub
Once you've run your modified test suite, you can check axe Developer Hub to review any accessibility issues found. See View Accessibility Issues for more information.
9. Continue to Run Your Test Suite
Whenever there is a new commit, re-run your test suite to collect accessibility information but also Git branch and commit info. If you're using GitHub, consider using the axe Developer Hub GitHub action that runs your test suite automatically whenever there is a commit.