Reading the repo
Reading the repo
Saved setup from 8 h ago
Will it work on my device?
DEVELOPMENT.mdpackage.jsoncorepack enable
pnpm install --frozen-lockfile
pnpm build:ui
pnpm generate:docs
pnpm dev
Open http://localhost:3000. No environment variables are required.
packages/ui/src and examples in
packages/ui/examples.pnpm dev to work on the documentation site with hot reload.pnpm generate:docs after changing examples or public component props.pnpm check:release before opening a pull request.To keep local and remote branches aligned:
git pull --rebase --tags origin main
pnpm build
pnpm typecheck
pnpm test
pnpm check:coverage
pnpm pack:ui
node scripts/smoke-package.mjs
pnpm check:release runs the complete release validation, including
independent npm and pnpm consumer smoke tests.
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install
git clone https://github.com/regzimarx/staqui.git cd staqui
Node.js >=22.0.0
# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm) nvm install --lts
corepack enable pnpm install
pnpm dev
pnpm test
No reports for macOS yet.
Opens a chat with this manual already filled in, for macOS. It uses your own account; gitmanual sends nothing.