uxkit

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

Two steps

1. Clone the repo

   git clone https://github.com/eshavrov/uxkit.git

2. Install NPM packages

   npm install

Development scripts

Useful scripts include:

Run project

npm run start

Build project

npm run build

Linting

boolean check if code conforms to linting rules - uses eslint

npm run lint

will automatically fix

npm run lint:fix

Run tests

boolean check if unit tests all pass - uses jest

npm run test

indicates that test coverage information should be collected and reported in the output.

npm run test:coverage

will run core tests in watch-mode

npm run test:watch

Storybook

npm run storybook

npm run storybook:build

Standards

• Web Content Accessibility Guidelines (WCAG) 2.2 publication history WCAG-2.2
• W3C Accessibility Guidelines (WCAG) 3.0 publication history WCAG-3.0
• Section 508 link
• ARIA Authoring Practices Guide APG