Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
91 lines (62 sloc) 3.22 KB

npm version CircleCI


You can find documentation and examples on our docs page.

Quick start guide

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

npm install @bigcommerce/big-design styled-components

or with yarn:

yarn add @bigcommerce/big-design styled-components

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';


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


This is a monorepo that uses Lerna and Yarn Workspaces.

Workspaces are inside the packages directory.


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


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


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

yarn run build
yarn run start

Run tests with:

yarn run test

Run linter with:

yarn run lint
You can’t perform that action at this time.