@kashlewa.ju93/faster-ui
v1.0.2
Published
Button, Input, and Dialog components for PUMA's Faster design system.
Downloads
32
Readme
@kashlewa.ju93/faster-ui
Button, Input, and Dialog components for Faster design system.
Storybook: https://juliaju93.github.io/Puma/
Requirements
ffff
- Node 20+ (see
.nvmrc) - pnpm
Getting started
pnpm install
pnpm dev # Storybook at http://localhost:6006Scripts
| Script | What it does |
| --- | --- |
| pnpm dev / pnpm storybook | Start Storybook |
| pnpm build | Build the library to dist/ (ESM + CJS + .d.ts + CSS) |
| pnpm build-storybook | Build the static Storybook site |
| pnpm typecheck | tsc --noEmit |
| pnpm lint | ESLint |
| pnpm format | Prettier, writes in place |
| pnpm test / pnpm test:watch | Jest (unit + accessibility via jest-axe) |
| pnpm cypress:component | Cypress component tests (headless) |
Using the library
import { Button } from "@kashlewa.ju93/faster-ui";
import "@kashlewa.ju93/faster-ui/styles.css";
function App() {
return <Button variant="primary">Hello</Button>;
}The stylesheet import is required — components ship unstyled without it.
React and ReactDOM are peer dependencies (^18.2.0 || ^19.0.0); this package never bundles its own
copy.
Releasing
Versioning and publishing go through Changesets:
- Add a changeset with
pnpm changesetdescribing the change. - On merge to
main, CI opens a "Version Packages" PR bumping versions and updatingCHANGELOG.md. - Merging that PR publishes to npm, provided the
NPM_TOKENrepository secret is set. Without it, the release job still runs and stays green, it just skips the publish step.
