Shared React components for use across the Mural platform.
We use Storybook as both a living documentation site and dev environment. To get started:
- Clone the repo
npm installnpm run dev
To run tests locally:
npm run test
If you need to verify your local changes in an external project see our Local Environment Guide.
Within the project you'll find the src/ directory, which logically groups components together. For more information on our components see our Component standards
The source of truth for component and token documentation is at http://uitoolkit.mural.co/. Sign in with your Google account and explore.
If you have any questions or feedback, please let us know in slack #ask-fe-platform
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/storybook_docs. For documentation on how to write Storybook stories.
During deployments we remove the docs and strip comments.