0.1.0-alpha.2 • Published 1 year ago

@compassion-global-experience/core v0.1.0-alpha.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Compassion’s Core Design System

The @compassion-gds/core package serves as a framework-free base allowing to apply the Compassion Design System to any web application.
Framework-specific packages are available to apply the Compassion Design System to specific frameworks.

Install the dependencies

  • Run npm install

Building CSS variables

  • Run npm run build

Running storybook

  • Run npm start or npm run storybook

Contributing to the @compassion-gds/core Package

The @compassion-gds/core package is structured with a component-per-directory convention inside the src directory. Each component directory generally contains 2 items:

  • A CSS file composable css classes to achieve the design system specs
  • A .stories.js file that illustrates most of the ways the component can be configured