Skip to content

florianduros/compound-web

 
 

Repository files navigation

Compound Web

This project is using Percy.io for visual regression testing. Quality Gate Status Coverage

React implementation of Compound – Element's design system – See full documentation on https://compound.element.io and the Figma component library

Commands

Command Runs
yarn dev Runs a local development environment
yarn test Tests all components
yarn lint Lints all components
yarn gen:component $name Bootstraps a new component

Development

If you want to work on Compound Web as a linked package within a larger React application, TypeScript might complain about there being multiple copies of @types/react in the tree. You can work around this by linking Compound Web's copy of @types/react to your application's copy:

$ cd my-application/node_modules/@types/react
$ yarn link
$ cd ../../../../compound-web
$ yarn link @types/react

Release

To release a new version of Compound Web:

  1. Review the changes since last released and choose the appropriate version bump (major, minor, patch).
  2. Run the Release npm package action, inputting the version bump. The action will:
    • add a commit bumping the version in package.json
    • publish the package to npm
    • tag a release on Github
  3. Manually add a changelog to the release on github.

About

Web implementation of the Compound design system

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 75.8%
  • CSS 22.2%
  • JavaScript 1.9%
  • HTML 0.1%