Mural's UI Toolkit

Shared React components for use across the Mural platform.

Table of contents

• Quick start
• Documentation
• Component standards
• Contribution Guide

Quick start

We use Storybook as both a living documentation site and dev environment. To get started:

• Clone the repo
• npm install
• npm run dev

To run tests locally:

• npm run test

If you need to verify your local changes in an external project see our Local Enviroment Guide.

What's included

Within the project you'll find the src/ directory, which logically groups components together. For more information on our components see our Component standards

Documentation

Our doc site uses Storybook as living documentation and dev environment. We support mdx files and standard Storybook files, we use CSF version 3. You can find examples on how to add markdown docs to the doc section of our site in the src/storybookds_docs. For documentation on how to write Storybook stories.

During deployments we remove the docs and strip comments.