a11y-kit

# Installation

TIP

If you're planning on contributing (and please do!), you may want to familiarize yourself with Chaser324's forking document. Make sure you're working on a forked version of the project, not on the project itself.

# Prerequisites

  • Node.js - This project has been built on Node 12.x. Development may work on earlier versions. Feel free to try and update these docs with your results.
  • yarn - At least 1.x.

WARNING

yarn must be used in development, npm won't work here. This project relies heavily on Yarn Workspaces.

# Installation

To work on a package, first clone the entire repository.

# Via SSH
git clone git@github.com:a11y-kit/a11y-kit.git

# OR via HTTPS
git clone https://github.com/a11y-kit/a11y-kit.git

Once cloned, install dependencies

# Change into the cloned repository
cd a11y-kit

# Install all dependencies
yarn

# Test

It's a good idea to immediately test the codebase to make sure you're starting in a good place.

# Test _all_ packages at once
yarn test

If all tests do not pass, make sure you're on the master branch and the project was successfully installed. If you believe the setup was done correctly and the test failure is legitimate, open a new issue and describe what's going on.

← Understanding →