Documentation on our design system, design tokens (e.g. colors, spacing) and React components.
This projects contains two subprojects
/docs
- Homepage, main design system documentation (with Docusaurus) and docs for components with examples./web
- Documentation (with Storybook) for components with all details, React props and the corresponding Figma designs.
Both subprojects have their own Readme files and have a separate build process.
The design tokens are in /design-tokens
in the YAML format and are converted to JSON for the use with Storybook.
Grape Design Tokens for use with Theo.
In order to build storybook and the component library be sure to install Node.JS & yarn.
-
you need to install the dependencies by executing
yarn
this will also install dependencies for the "docs" and "web" projects.
-
Run
yarn build
to build storybook and the component library.
A new directory called build
is generated in the current directory which should be deployed.
It includes two folders that should be available under following URLs
build/storybook -> aurora.ubergrape.com/storybook
build/docs -> aurora.ubergrape.com