Community-ui NPM

CommunityUI

A React component library and UI kit. Built by the Community, for the Community. Storybook Logo

Getting Started

To install the library run the following command: npm install community-ui Then you can import the component of your choice by using the named import syntax. For example, if you want to import AnimatedButton, you'll need to add import { AnimatedButton } from 'community-ui' to the top of your file.

Documentation

Theming

By default, community-ui has a default theme applied. For the full documentation on theming, view the theme docs

Storybook

In order to view the storybook documentation, until the project is hosted in a production environement, simply follow the "Getting Started" steps in the contributing guidelines Then, you should see the storybook documentation, which will continue to grow as the project does.