Skip to content
🌱 Culture Amp's Kaizen Design System
TypeScript CSS JavaScript Shell Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.buildkite ci: Pull current master in release step (#50) Oct 16, 2019
.github ci: Add semantic PR title checks (#37) Oct 7, 2019
.vscode Add vscode linter config and recommendations Jun 13, 2019
packages docs: Update README and add CONTRIBUTING (#12) Oct 17, 2019
site docs: Order Components nav items with Overview at top (#56) Oct 17, 2019
storybook chore: Fix image loaders in Storybook webpack config (#53) Oct 16, 2019
.gitignore ci: Begin tagging and releasing packages (#48) Oct 15, 2019
.nvmrc Use node v10.16.3 LTS Sep 14, 2019
.prettierignore Merge storybook into the root workspace (#17) Sep 23, 2019
.prettierrc Set up prettier Jun 12, 2019
CODEOWNERS Initial commit 🌱 Jun 12, 2019
CONTRIBUTING.md docs: Update README and add CONTRIBUTING (#12) Oct 17, 2019
LICENSE Initial commit 🌱 Jun 12, 2019
README.md docs: Introduce and refactor the root readme (#57) Oct 17, 2019
docker-compose.yml ci: Replace ssm params with secrets-manager secrets Oct 15, 2019
elm.json Set up elm loaders and elm-storybook (#20) Sep 24, 2019
jest.config.js Use strictly scss/css extensions for stylesheets Sep 17, 2019
lerna.json ci: Stop versioning/tagging private packages (#55) Oct 16, 2019
package.json chore: Fix image loaders in Storybook webpack config (#53) Oct 16, 2019
tsconfig.json Move storybook package to the repository root Sep 19, 2019
tslint.json Merge storybook into the root workspace (#17) Sep 23, 2019
yarn.lock chore: Prepare for first release Oct 15, 2019

README.md

Kaizen Design System

Build status

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.

Quick links

Getting started

To begin developing the design system locally, run the following from the repository root:

yarn install

We use Storybook to provide a local development environment for React and Elm components. All Kaizen Design System components have accompanying stories in Storybook.

To run Storybook locally, run the following from the repository root:

yarn storybook

To develop the site locally, please refer to the documentation in the site package.

Package scripts

It's dangerous to go alone! Take these:

Command Summary
yarn storybook Develop components locally
yarn compile Run all typechecks
yarn lint Run all linters
yarn lint:fix Run all linters, fixing violations
yarn test Run all tests (using Jest)
yarn reset Reinstall all dependencies

Branch previews

While the main site is located at cultureamp.design, all branches in this repository are automatically deployed to a public URL at dev.cultureamp.design/(branch name).

For example, pushing the branch louis/more-glitter would make its documentation and Storybook build available at dev.cultureamp.design/louis/more-glitter.

Discussion, bugs and issues

Please open a new GitHub Issue to report bugs or suggest changes.

Maintainers

This repository is maintained (with ❤️) by Culture Amp's Design Systems Team, with tooling and operations support from Delivery Engineering. 🚀

Learn more

Culture Amp employees can reach out to the Design Systems Team on Slack in the #team_design_systems channel.


🌱

You can’t perform that action at this time.