https://github.com/cultureamp/kaizen-design-system
Culture Amp's Kaizen Design System :seedling:
https://github.com/cultureamp/kaizen-design-system
design-system design-systems kaizen kaizen-design-system react storybook styleguide typescript
Last synced: about 1 month ago
JSON representation
Culture Amp's Kaizen Design System :seedling:
- Host: GitHub
- URL: https://github.com/cultureamp/kaizen-design-system
- Owner: cultureamp
- License: mit
- Created: 2019-05-30T02:19:41.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-05-13T06:26:46.000Z (about 1 month ago)
- Last Synced: 2025-05-13T07:33:28.791Z (about 1 month ago)
- Topics: design-system, design-systems, kaizen, kaizen-design-system, react, storybook, styleguide, typescript
- Language: TypeScript
- Homepage: https://cultureamp.design
- Size: 86.6 MB
- Stars: 164
- Watchers: 31
- Forks: 23
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Kaizen Design System
[](https://buildkite.com/culture-amp/kaizen-design-system)
Kaizen is Culture Amp's public design system. It accelerates Culture Amp's designers and engineers as they collaborate on creating world-class products. Visit [cultureamp.design](https://cultureamp.design) to learn more.
This repository is the source of truth for Culture Amp's design system documentation and hosts packages such as [Kaizen Component Library](./packages/component-library), which are used across Culture Amp's products. It is structured as a multi-package repository, with a number of independently 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 README.
## Quick links
- [Kaizen Issues](https://github.com/cultureamp/kaizen-discourse/issues)
- [Kaizen Design Tokens README](./packages/design-tokens/README.md)
- [Contributing guidelines](./CONTRIBUTING.md)
## Designers
### Issues
You can explore or create [Issues](https://github.com/cultureamp/kaizen-design-system/issues/) to track ideas, enhancements, or bugs. Use issues to track:
- Changes to design documentation
- Missing documentation
To learn more, see the designer section of the [Contributing guidelines](./CONTRIBUTING.md).
### Editing design documentation
You can edit Kaizen Site documentation using GitHub's interface.
To learn more, see the designer section of the [Contributing guidelines](./CONTRIBUTING.md).
## Getting started
### Setup
Set up access to private Culture Amp packages on your laptop. You will need to update `~/.npmrc` with a Github token linked to your account. Refer to the [instructions here](https://cultureamp.atlassian.net/wiki/spaces/TV/pages/2776629375/Working+with+our+private+GitHub+package+registry).
### Local development
Ensure devbox is setup as per [https://cultureamp.atlassian.net/wiki/spaces/DE/pages/3342434338/Devbox+setup](https://cultureamp.atlassian.net/wiki/spaces/DE/pages/3342434338/Devbox+setup)
Install and start processes (this start an interactive UI in your terminal) `devbox services up`
The interactive terminal UI that pops up is called process-compose, see our [Confluence page](1) for tips on how to use it.
Please see the [LDE Confluence page](2) for more information
[1]:
[2]:
(Having trouble running Storybook? Try running `pnpm reset`, which includes `pnpm clean` and `pnpm install --force`!)
## Branch previews
While the main site is located at , all branches in this repository are uploaded to Chromatic. Your branch will be updated with a comment containing a link when the upload has completed.
## Package scripts
It's dangerous to go alone! Take these:
| Command | Summary |
| :--------------------------------------- | :------------------------------------------------------------------ |
| `pnpm storybook` | Develop components locally using Storybook |
| `STORIES=path/to/package pnpm storybook` | Develop just one package at a time using Storybook (builds faster!) |
| `pnpm compile` | Run all typechecks |
| `pnpm lint` | Run all linters |
| `pnpm lint:fix` | Run all linters, fixing violations |
| `pnpm plop` | Add a new component/subcomponent |
| `pnpm test` | Run all [Jest](https://jestjs.io/) tests |
| `pnpm storybook:test` | Run tests on all Storybook stories |
| `pnpm reset` | Reinstall all dependencies |
## Bugs and discussions
Please open a new [GitHub Issue](https://github.com/cultureamp/kaizen-design-system/issues/new) to report bugs or suggest changes.
## Learn more
Culture Amp employees can reach out to the Unified Systems crew on Slack.