An open API service indexing awesome lists of open source software.

https://github.com/flanksource/clicky-ui


https://github.com/flanksource/clicky-ui

Last synced: 8 days ago
JSON representation

Awesome Lists containing this project

README

          

# Clicky UI

Flanksource's React component library built on [shadcn/ui](https://ui.shadcn.com/) with first-class light/dark and density theming.

- **Library** (`packages/ui`) — React + TypeScript + Tailwind, published as `@flanksource/clicky-ui`.
- **Storybook** (`apps/storybook`) — Autodocs component catalog with interaction tests.
- **Kitchen Sink** (`apps/kitchen-sink`) — Preact-hosted demo proving runtime compatibility.
- **E2E** (`e2e`) — Playwright tests against the kitchen sink.

Toolchain: Vite + Vitest + Storybook + Playwright + pnpm workspaces.

## Quick start

```bash
pnpm install
pnpm run build
pnpm run dev:storybook # http://localhost:5270
pnpm run dev:kitchen-sink # http://localhost:5273
```

## Workspace scripts

- `pnpm run check` — format check, lint, and TypeScript project check.
- `pnpm run test` — build demo apps and run unit, Storybook, and Playwright tests.
- `pnpm run build` — build the publishable UI package.
- `pnpm --filter @flanksource/clicky-ui pack` — inspect the npm package artifact.