Manage Your axe Developer Hub Projects
How to manage your axe Developer Hub projects from the Projects page
axe Developer Hub is a beta product and is subject to change.
Projects are how axe Developer Hub collects and organizes your:
- Test run results and accessibility issues
- Git commit and branch information (only if using Git)
Visit your projects page here: Projects Page
The projects page contains all of your axe Developer Hub projects. There are columns for the project name, when the project was created (in relative time), when your test suite was last run (in relative time), and actions that you can perform on each project. You can page between multiple project pages.
|Go to your project's top level page. Same as clicking on the project's name in the Project Name column. See View Accessibility Issues.|
|Copy your project's API key to the clipboard to integrate into your automated tests.|
|View your project's quickstart instructions or change your project's browser automation platform.|
Click on the ADD A NEW PROJECT button in the upper right of this page. For more information, see Create a Project.
You cannot delete a project from the projects page. You need to visit the API Keys page to do that. See Delete a Project.
If you'd like to re-review the instructions that axe Developer Hub gives you when you created a project, go to the projects page and click on the button showing the running person (see Project Actions above). You'll be taken to a page to select the browser automation where you can review the instructions or change the browser automation platform.
You can sort your projects (ascending or descending) by clicking on these columns:
- Project Name
- Project Created
- Last Run
Whenever you run your test suite, you add records to axe Developer Hub (containing information about accessibility defects and Git commits and branches). Suppose you are engaged in rapid code-test-debug cycles on your local machine (you run your test suite frequently as you develop new tests, for instance). In that case, you probably don't want any of the information the @axe-core/watcher package collects saved to the main axe Developer Hub project as you try out different code paths.
A possible solution is to create a new axe Developer Hub project and use its API key to collect the local test run data. Local development would use the new project's API key. In contrast, CI automation would use the main project's API key.
- Use environment variables to select the appropriate API key for local machine development versus the main project's API key with CI automation on your Git host.
- Adopt a naming convention for locating your local development projects. For instance, if your main project is project1, call your local development project project1-localdev.
Never use the same axe Developer Hub API key with multiple Git repositories. You will overwrite axe Developer Hub data associated with the API key you reused.