Shopify’s design system to help us work together to build a great experience for all of our merchants.

The shopify/polaris repository is an intergalactic monorepo made up of NPM packages, VSCode extensions, Figma plugins and websites.

polaris/
├── documentation               # Documentation for working in the monorepo
├── polaris-for-figma           # Figma plugin for Polaris
├── polaris-for-vscode          # VS Code extension for Polaris
├── polaris-icons               # Icons for Polaris
├── polaris-react               # Components for @shopify/polaris package
├── polaris-tokens              # Design tokens for Polaris
├── polaris.shopify.com         # Documentation website
└── stylelint-polaris           # Rules for custom property usage and mainline coverage

1. Install dependencies

yarn

2. Build the packages

yarn build

3. Start a local development environment

Start a storybook server for the polaris-react components

yarn workspace @shopify/polaris dev

Start a NextJS server for polaris.shopify.com

yarn workspace polaris-shopify-com dev

Pull requests are welcome. See the contribution guidelines for more information.

Source code is under a custom license based on MIT. The license restricts Polaris usage to applications that integrate or interoperate with Shopify software or services, with additional restrictions for external, stand-alone applications.

All icons and images are licensed under the Polaris Design Guidelines License Agreement