Skip to content

blockchain/constellation

Repository files navigation

Constellation

Constellation is Blockchain.com's open sourced component library and base code linting configs.

license

Installation/Usage

@blockchain-com/icons must be built before running repo's storybook, so first:

yarn && yarn workspace @blockchain-com/icons build

After building the icons run storybook with:

yarn storybook

Constellation is mono-repo of various open-sourced packages available on NPM. Find more details on each package below.

Packages

Name Description
constellation Our base component library for React based applications.
eslint-config-constellation Our base ESLint ruleset.
prettier-config-constellation Our base Prettier ruleset.
stylelint-config-constellation Our base Stylelint ruleset.
@blockchain-com/icons React Icons

For more details on the packages above, see their README.md's

Publish To NPM

  1. Bump the package.json to next version following Semantic Versioning
  2. Commit change for version bump
  3. Depending on your setup, run either of the following commands from project root
`yarn workspace [package] npm publish` or `npm publish`

Deploying Storybook

yarn workspace @blockchain-com/constellation deploy:storybook