Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 836 Bytes

README.md

File metadata and controls

42 lines (27 loc) · 836 Bytes
Raw

👋 Welcome to the Scout component library & styleguide!

Here you can find:

  • Assets and resources for Scout's brand
  • Living React component library with Scout styling

Why a component library?

A common library provides several benefits for implementing apps under Scout:

  • Keep components consistent & reusable
  • Develop all components to be standalone and independent
  • View at a glance if any breaking changes were introduced to any of the components

Installation & Usage

Install using npm:

npm install git+https://github.com/Scout-NU/react-components.git

Import components:

import { Button } from 'react-components';

Development

Start the dev server (localhost:6060):

styleguidist server

Build the styleguide to /dist folder

styleguidist build