Development setup

To work on this project, you'll need to do some setup.

Requirements

Ensure you have the following installed

• Node - you can use nodenv to install the right version with nodenv install

Clone the project

Clone the repo by navigating to the location on your system where you want the project to live, and running

git clone git@github.com:chanzuckerberg/axe-storybook-testing.git

When that's done, navigate to the project directory

cd axe-storybook-testing

Install project dependencies

Install the necessary development dependencies with

npm install

Test your setup

Make sure everything is working by running any or all of the following (each command is independent, and can be ran in any order):

• npm run demo:storybook - Run the demo app's Storybook.
• npm run demo - Run axe-storybook-testing on the demo app. There should be some "failures".
• npm run demo:eds - Run axe-storybook-testing on the Education Design System storybook. There should be no failures.
• npm run validate - Run linting, type checking, unit tests, and integration tests in one command.

And, you're done!

Congrats! You have a fully-functional development setup.