readme.md

Common UI

Common UI is a framework-agnostic collection of UI components, for Camunda Cloud.

Documentation

You can find the current documentation here

Getting Started

To start contributing to Common-UI, clone this repo to a new directory:

git clone https://github.com/camunda-cloud/common-ui.git common-ui
cd common-ui
git remote rm origin

you will need to login into the @camunda-cloud scope in github packages (npm), you can find out how here: https://github.com/features/packages

afterwards you can run:

yarn
yarn start

To serve the storybook documentation locally, run:

yarn storybook

NOTE: The Documentation depends on @camunda-cloud/common-ui-react - it will not reflect local development changes, just changes to the .mdx stories. Use src/index.html for local development. It gets served when you run yarn start and contains the native web components freshly compiled from the local source.

To build the component for production, run:

yarn build

To run the unit tests for the components, run:

yarn test