Skip to content

README.md

Latest commit

 

History

History
62 lines (38 loc) · 2.15 KB

README.md

File metadata and controls

62 lines (38 loc) · 2.15 KB

TEDI Design System for React

@tedi-design-system/react is a library of React components implementing the TEDI Design System. It provides reusable, accessible, and consistent UI components to streamline building React applications.

Usage instructions and detailed documentation for using the components in your application are available in Storybook.

codecov semantic-release

Getting Started (Using the package)

If you are installing @tedi-design-system/react in your own project, follow the Get Started guide in Storybook

The Storybook documentation covers:

  • installation instructions
  • required styles and providers
  • component usage examples
  • accessibility notes
  • component APIs

Repository Development Guide (Contributors)

The following instructions apply only if you are working on this repository itself (e.g. developing, fixing, or adding components).

Install dependencies

npm install

Running Storybook locally

To view and develop components in isolation, start Storybook:

npm run start

This will launch a local Storybook instance for component development.

Contributing

Check the wiki for component guidelines and coding standards.
Report issues or contribute via GitHub Issues.

Visual Testing

Chromatic

We use Chromatic for visual testing, reviewing UI changes, and preventing visual regressions.