0.1.0 • Published 2 years ago

@omni-dev/design-system v0.1.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Omni Design System

Implementations and technical specifications for the Omni design system.

⚠️ Note that the current implementation is not strictly a design system, but rather a React component library. This will change as the project evolves.

How does this work?

In its current form, the Omni Design System primarily abstracts or "facades" components from Chakra UI, and, as a consequence, is highly coupled to the evolution of Chakra UI itself. In other words, it largely composes Chakra UI, with foreign components sprinkled in.

Local Development

yarn dev will spin up Rollup in watch mode as well as a local Storybook server. Hot reloading is supported; changes will be reflected instantly on Storybook.

Testing

Jest- and React Testing Library-powered unit tests can be run with yarn test. All Jest CLI options are supported, however test:coverage and test:watch scripts are provided for convenience.

Building

The library can be built with Rollup using yarn build.

License

The code in this repository is licensed under MIT, © Brian Cooper and Omni LLC. See LICENSE.md for more information.