Kaizen Design System
Kaizen is Culture Amp's design system. It accelerates Culture Amp's designers and engineers as they collaborate on creating world-class products. Visit cultureamp.design to learn more.
This repository represents the source of truth for Culture Amp's design system documentation, as well as a number of public front-end packages, such as the Kaizen Component Library used in Culture Amp's products. It is structured as a multi-package workspace, with a number of independently released and versioned projects sharing common tools, workflows and vision.
This document serves to orient you within the repository — to get you set up and acquainted, and then send you off in the right direction. For more information on any specific package, please refer to its respective README.
To begin developing the design system locally, run the following from the repository root:
To run Storybook locally, run the following from the repository root:
To develop the site locally, please refer to the documentation in the site package.
It's dangerous to go alone! Take these:
||Develop components locally|
||Run all typechecks|
||Run all linters|
||Run all linters, fixing violations|
||Run all tests (using Jest)|
||Reinstall all dependencies|
For example, pushing the branch
louis/more-glitter would make its documentation and Storybook build available at
Discussion, bugs and issues
Please open a new GitHub Issue to report bugs or suggest changes.
Culture Amp employees can reach out to the Design Systems Team on Slack in the