/plaited

Rapidly design & develop interfaces as requirements change and evolve

Primary LanguageTypeScriptISC LicenseISC

Build/Tests

Plaited

Plaited is design system first framework for rapidly designing and developing interfaces as requirements change and evolve. This mono repo serves as the workspace for working on our development libraries and tooling. It is divided into 4 workspaces.

  • Rendering libraries, state managment and utilities
  • Design token format libraries and tooling
  • Test library
  • Storybook development libraries and tooling

Dev Requirements

local

  • bun >= 1.0.7

devcontainer requirements

  • vscode
  • Docker

Dev Setup

local setup

  1. Clone repository and ensure you have bun >= 1.0.7
  2. Run bunx playwright install
  3. Run bash scripts/setup.sh

devcontainer setup

  1. Install docker on local machine
  2. Ensure docker desktop daemon/app is running
  3. Open new window for VSCode
  4. ctrl/cmd + shift + p
  5. search for Dev Containers:Clone Repository in Container Volume
  6. Enter this repo name plaited/plaited
  7. Wait for it to download and set everything up
  8. Open a VSCode terminal tab and run zsh setup.sh