@comicrelief/component-library

Comic Relief React Component Library
--------------


React components to be shared across Comic Relief applications

$3

CR-CL has a dependency of Styled-components.

#### Install the package
``
$ yarn add @comicrelief/component-library
`

#### Wrap your app with the ThemeProvider and crTheme
`
import { ThemeProvider, crTheme } from '@comicrelief/component-library';
`

#### Import components
`
import { HeroBanner } from '@comicrelief/component-library';
`

$3

To install CR-CL locally, run:

`
$ yarn install
`

To start the dev build and server:
`
$ yarn styleguide
`

To test:
`
$ yarn test:unit
`
_Test will run through all Jest tests and watch for any changes on snapshots._

To update snapshots with desired changes brought in through your work:
`
$ yarn test:unit:update
`

To publish
`
$ yarn publish:npm
`

$3

Install Playwright:
`
yarn playwright install
`

Run the tests:
`
yarn test:e2e:local
``