[READ-ONLY] Mirror of https://github.com/lukebennett88/luke-ui. ui.lukebennett.dev
TypeScript 86%
MDX 10%
CSS 4%

README.md

Luke UI #

React design system built with react-aria-components and vanilla-extract.

Setup #

pnpm install
pnpm dev

Useful repo commands:

  • pnpm run check: lint, format, and typecheck.
  • pnpm run build: build all packages and apps.
  • pnpm run test: run unit, Storybook, and visual regression tests.

Stack #

  • Monorepo: pnpm and Turbo.
  • React: react-aria-components.
  • Styling: vanilla-extract static CSS.
  • Lint and format: oxlint and oxfmt.

Package #

@luke-ui/react contains the public React package.

  • Theme contract and compiler: packages/@luke-ui/react/src/theme/.
  • Styles: packages/@luke-ui/react/src/styles/.
  • Build output: packages/@luke-ui/react/dist/stylesheet.css.

Docs #

  • Conventions: repo-wide coding conventions.
  • Components: component tiers, package paths, and generator rules.
  • Documentation: hosted docs ownership, MDX structure, examples, and API reference.
  • Styling: cascade layers, recipes, and styling utilities.
  • Testing: test type, placement, and writing rules.
  • Visual testing: visual regression workflow.

Contributing #

Run pnpm run check before committing.

Use pnpm changeset when a change needs a package version entry.