mt-webdev / swirl

Flip's design system to help us work together to build a great experience for all of our customers.

Swirl

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

Status	Owner	Help
Active	@getflip/swirl	New issue

About this repo

The Flip/swirl repository is a monorepo made up of NPM packages and websites.

swirl/
├── swirl-icons                 # Icon Set for Swirl
├── swirl-tokens                # Design Tokens for Swirl
├── swirl-components            # Web Components Library for Swirl
├── swirl-components-angular    # Angular Components Wrapper
├── swirl-components-react      # React Components Wrapper

Commands

Install dependencies and build workspaces

yarn && yarn build

Run a command

One workspace

Run commands from a selected workspace using turbo run <command> --filter=<workspace>... flag.

All workspaces

Run commands across all workspaces. This uses turbo run <command>.

Command	Runs
yarn dev	Start dev environment (Storybook)
yarn changeset	Adds a new changelog entry
yarn lint	Lints all workspaces
yarn test	Tests all workspaces
yarn type-check	Build types and check for type errors
yarn clean	Remove generated files
yarn format	Format files with prettier

Licenses

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