Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shopify/polaris
Shopify’s design system to help us work together to build a great experience for all of our merchants.
https://github.com/shopify/polaris
component-library design-system design-systems design-tokens figma-plugin icons react shopify-polaris typescript vscode-extension
Last synced: 5 days ago
JSON representation
Shopify’s design system to help us work together to build a great experience for all of our merchants.
- Host: GitHub
- URL: https://github.com/shopify/polaris
- Owner: Shopify
- License: other
- Created: 2017-04-20T18:26:34.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-01-02T07:43:18.000Z (10 days ago)
- Last Synced: 2025-01-02T13:09:07.966Z (9 days ago)
- Topics: component-library, design-system, design-systems, design-tokens, figma-plugin, icons, react, shopify-polaris, typescript, vscode-extension
- Language: TypeScript
- Homepage: https://polaris.shopify.com
- Size: 262 MB
- Stars: 5,848
- Watchers: 510
- Forks: 1,184
- Open Issues: 251
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- shopify-development-resources - Polaris React Components
README
# Polaris
> Build. Contribute. Evolve. Shape the merchant experience for Shopify’s core product, the admin.
[![storybook](https://shields.io/badge/storybook-grey?logo=storybook&style=flat)](https://storybook.polaris.shopify.dev) [![npm version](https://img.shields.io/npm/v/@shopify/polaris.svg?label=@shopify/polaris)](https://www.npmjs.com/package/@shopify/polaris) [![CI](https://github.com/shopify/polaris/workflows/CI/badge.svg)](https://github.com/Shopify/polaris/actions?query=branch%3Amain) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#your-first-pull-request)
| Status | Owner | Help |
| ------ | ---------------- | ---------------------------------------------------------- |
| Active | @shopify/polaris | [New issue](https://github.com/Shopify/polaris/issues/new) |## About this repo
The shopify/polaris repository is an [intergalactic](https://www.youtube.com/watch?v=qORYO0atB6g) monorepo made up of NPM packages, VSCode extensions, and websites.
```sh
polaris/
├── documentation # Documentation for working in the monorepo
├── 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
```## Commands
### Install dependencies and build workspaces
```sh
pnpm install && pnpm build
```### Run a command
**One workspace**
Run commands from a selected workspace using [`turbo run --filter=...`](https://turborepo.org/docs/core-concepts/filtering) flag.
| Command | Runs |
| ------------------------------------------------- | ------------------------------------ |
| `pnpm turbo run dev --filter=@shopify/polaris` | Open the react component storybook |
| `pnpm turbo run dev --filter=polaris.shopify.com` | Open polaris.shopify.com NextJS site |**All workspaces**
Run commands across all workspaces. This uses [`turbo run `](https://turborepo.org/docs/reference/command-line-reference#turbo-run-task).
| Command | Runs |
| ----------------- | --------------------------------------------------------------------------------------------------------------------- |
| `pnpm changeset` | Adds a new [changelog entry](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#adding-a-changeset) |
| `pnpm lint` | Lints all workspaces |
| `pnpm test` | Tests all workspaces |
| `pnpm type-check` | Build types and check for type errors |
| `pnpm clean` | Remove generated files |
| `pnpm format` | Format files with prettier |## Contribute to this repo
Pull requests are welcome. See the [contribution guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md) for more information.
## Licenses
Source code is under a [custom license](https://github.com/Shopify/polaris/blob/main/LICENSE.md) 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](https://polaris.shopify.com/legal/license)