Skip to content

asudoh/carbon-addons-website

 
 

Repository files navigation

Carbon addon for live component demo

React component library for live component demo

This repository provides a collection of React components, based on Carbon Components, to be used in its live component demo.

Usage

Getting Started

> npm install -S carbon-components carbon-components-react carbon-addons-cloud carbon-icons classnames markdown-it react react-copy-to-clipboard react-dom react-ga
  1. These components require the use of a module bundler, e.g. Webpack in your project. See our webpack.config.js for an example configuration.

  2. Components do not import any of the styles themselves, use your Sass tool to bring in src/components/**/*.scss.

Development

Please refer to the Contribution Guidelines before starting any work.

Using the server

We recommend the use of React Storybook for developing components.

  1. Start the server:

    $ npm run storybook
    
  2. Open browser to http://localhost:9000/.

  3. Develop components in their respective folders (carbon-addons-website/src/components).

  4. Write stories for your components (carbon-addons-website/src/components/**/*-story.js).

Contributing

Please check out our Contribution Guidelines for detailed information on how you can lend a hand.

About

Carbon Design System add-on for design system website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 52.6%
  • JavaScript 47.4%