PAUS tools

Performance, accessibility, usability, security. They're all important and work on one often affects the others. This repo is (and will be) a collection of tools and learning applications to help designers, developers, and product managers level up. It is divided into two broad categories:

packages

The packages directory includes co-located tools for testing or evaluating PAUS in your applications. Packages uses Nx to manage global dependencies and testing tools.

examples

The examples directory includes one-off learning applications. It currently has two applications:

1. screen reader semantics demonstrates the importance of semantic HTML for screen reader users
2. design review helps designers spot visual a11y issues and learn about annotating visual designs

Get started coding on your machine

This repo requires you to type a few commands into a terminal window. Commands are shown in code blocks that begin with a dollar sign like this $ command to type. You can retype these commands or copy and paste them into your terminal window. Do not include the dollar sign $ when you type or copy commands into your terminal.

1. Confirm you have NodeJS installed. Open a terminal and type $ node --version
2. You should see output like v16.14.2. If not, download NodeJS and install it on your local machine.
3. Clone this repo. If you’ve never cloned a repo, GitHub has great instructions.
4. Then type the following commands, one at a time:
5. $ cd /paus-tools/ to change directories
6. $ cd /packages/ or $ cd /examples/` depending on if you want to use tools or learning examples
7. $ npm install to install dependencies
8. View the package.json in the desired directory for local instructions. Often this will be $ npm run start to start a development server.
9. The application will compile and your terminal should provide a local URL like localhost:3000 or localhost:8080 to view the application.