/charcoal

Design system library by pixiv

Primary LanguageTypeScriptApache License 2.0Apache-2.0

@charcoal-ui ― PIXIV Design System monorepo

test Storybook

This is the monorepo for the @charcoal-ui packages by pixiv.

How to use

See our documentation, or README of each package in /packages.

NPM Packages

package version
@charcoal-ui/foundation styled npm version
@charcoal-ui/icons styled npm version
@charcoal-ui/icons-cli styled npm version
@charcoal-ui/react styled npm version
@charcoal-ui/react-sandbox styled npm version
@charcoal-ui/styled styled npm version
@charcoal-ui/tailwind-config styled npm version
@charcoal-ui/tailwind-diff styled npm version
@charcoal-ui/theme styled npm version
@charcoal-ui/utils styled npm version

Contribution

Setup

Requires yarn and nodenv.

nodenv install `cat .node-version`
yarn install

Development

Start the development server on http://localhost:6006

yarn build
yarn storybook

If you want to start development for documentation site, run the following command and go to http://localhost:5000

yarn website

Commit

@charcoal-ui is using commitlint and following the Conventional Commits rules.