shru-design-system
v0.6.2
Published
A React component library built with Tailwind CSS
Maintainers
Readme
shru-design-system
React component library — 99 components, multi-axis token themes, Tailwind + CVA.
npm install shru-design-system
npx shru-design-system-initPublished: dist/ components, styles.css, Tailwind preset.
Prop-level API: TypeScript XxxProps · local dev: npm run dev → /gallery
Documentation
| Audience | Start here | |----------|------------| | Consumer — install & use in your app | docs/use/INSTALL.md | | Contributor — change this repo | docs/build/CONTRIBUTING.md | | Architecture — system structure | docs/reference/ARCHITECTURE.md |
Consumers — docs/use/
| Doc | Covers |
|-----|--------|
| Install | Peers, init, styles, Tailwind, first component |
| Theming | Presets, useTheme, applyPreset, ThemeToggle |
| Recipes | App shell, TreeView, forms, modals |
| Features | Overlays, toasts, forms, input API contracts |
Contributors — docs/build/
| Doc | Covers |
|-----|--------|
| Contributing | Layout, conventions, tokens, checks |
| Components | Add / update component checklist |
| Gallery | Metadata pipeline, wrappers |
| Release | npm run check, build, publish |
Architecture — docs/reference/
| Doc | Covers | |-----|--------| | Architecture | Repo map, build pipeline, check gates | | Components | 99 shipped spec | | Component graph | Composition flowcharts | | Tokens | Token JSON layout, pipeline |
Local preview
npm run dev| Route | Purpose |
|-------|---------|
| /gallery | Component catalog + props panel |
| /showcase | Mini admin app (composed patterns) |
