Polaris

Shopify’s design system to help us work together to build a great experienc...

Component ToolkitReactDesign System
Shopify/polarispolaris.shopify.com@shopify/polaris

README


Polaris


Build. Contribute. Evolve. Shape the merchant experience for Shopify’s core product, the admin.

storybook npm version CI PRs Welcome

StatusOwnerHelp
--------------------------------------------------------------------------------
Active@shopify/polaris[New

About this repo


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

  1. ```sh
  2. polaris/
  3. ├── documentation               # Documentation for working in the monorepo
  4. ├── polaris-for-vscode          # VS Code extension for Polaris
  5. ├── polaris-icons               # Icons for Polaris
  6. ├── polaris-react               # Components for @shopify/polaris package
  7. ├── polaris-tokens              # Design tokens for Polaris
  8. ├── polaris.shopify.com         # Documentation website
  9. └── stylelint-polaris           # Rules for custom property usage and mainline coverage
  10. ```

Commands


Install dependencies and build workspaces


  1. ```sh
  2. yarn && yarn build
  3. ```

Run a command


One workspace

Run commands from a selected workspace using [`turbo run --filter=...`](https://turborepo.org/docs/core-concepts/filtering) flag.

CommandRuns
-------------------------------------------------------------------------------------
`yarnOpen
`yarnOpen

All workspaces

Run commands across all workspaces. This uses [`turbo run `](https://turborepo.org/docs/reference/command-line-reference#turbo-run-task).

CommandRuns
--------------------------------------------------------------------------------------------------------------------------------------
`yarnAdds
`yarnLints
`yarnTests
`yarnBuild
`yarnRemove
`yarnFormat

Contribute to this repo


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