---

Documentation

You can find documentation and examples on our docs page.

Quick start guide

Add BigDesign and styled-components@4 to your project using npm:

npm install @bigcommerce/big-design styled-components@4

or with yarn:

yarn add @bigcommerce/big-design styled-components@4

Import the GlobalStyles component and use it once in your app. This will set a few styles globally, including a base font family, Source Sans Pro and normalize.css. We recommend placing it close to your root component. Then import any component, such as Button, to use it anywhere in your app.

import { Button, GlobalStyles } from '@bigcommerce/big-design';

...

<App>
  <GlobalStyles />
  <Button>Click me</Button>
</App>

Monorepo

This is a monorepo that uses Lerna and Yarn Workspaces.

Workspaces are inside the packages directory.

• big-design: React component library.
• big-design-theme: Default Theme.
• big-design-icons: Icons library.
• docs: Documentation live here.
• configs: (internal) Shared configs between packages.

Changelogs

As this is a monorepo, each package has it's own Changelog. Links for each can be found below

• big-design
• big-design-theme
• big-design-icons
• configs
• docs

Contributing

To contribute, please read our Contributing guidelines and Code of Conduct first.

Development

Running the following commands will run big-design and docs in watch mode.

yarn
yarn run build
yarn run start

Run tests with:

yarn run test

Run linter with:

yarn run lint