This is a simple React application for demonstrating the use of various accessibility testing tools. The project was bootstrapped with Create React App and styled with Tailwind CSS. It uses Storybook to facilitate building UI components in isolation.
git clone https://github.com/ImagineLearning/a11y-tools-workshop.git
cd a11y-tools-workshop
yarn install
yarn startThe following software/configuration is needed to work with this project.
This project is built to work with current versions of Node. Using a tool like Node Version Manager (nvm) is recommended. Follow the instructions for installing on your platform:
If you prefer not to use nvm, you can download the installer for your platform from the Node website
This project uses Yarn for managing dependencies. If you do not have have Yarn installed on your system, follow the installation instructions on the Yarn website.
Alternatively, you can use npm for managing dependencies.
This workshop will make use of packages hosted through GitHub Package Registry (GPR). Currently, GPR requires an access token even if the package is publicly available. Be sure you've properly configured Yarn with your personal access token to avoid issues installing packages.
Install the project dependencies by running the following command in the project directory:
yarn installStart the development server by running the following command in the project directory:
yarn startOpen http://localhost:3000 to view it in the browser.
The page will reload if you make edits. You will also see any lint errors in the console.
Start the Storybook development server by running the following command in the project directory:
yarn storybookOpen http://localhost:6006 to view it in the browser.
The page will reload if you make edits.
Launches the test runner in the interactive watch mode by running the following command in the project directory:
yarn testSee the section about running tests for more information.
You can learn more from the Create React App documentation and Storybook documentation.