romellogoodman / polaris

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

Polaris

Polaris is our design system that helps us work together to build a great experience for all of Shopify’s merchants. Visit the Polaris style guide to learn more.

Folder

polaris/
├── documentation               # Documentation for working in the monorepo
├── polaris-for-vscode          # VSCode plugin for Polaris
├── polaris-react               # Components for @shopify/polaris package
└── polaris-shopify-com         # Documentation website

Getting Started (One time)

1. Initialize the repository by installing external dependencies and symlinking internal packages.

yarn install

2. Build every package in the monorepo.

yarn build

Local development

Develop polaris.shopify.com in watch mode:

yarn dev

Develop polaris-react in watch mode:

yarn dev:react

Contributing

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

Licenses

• 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