Skip to content

Latest commit

History

History
49 lines (33 loc) · 1.75 KB

File metadata and controls

49 lines (33 loc) · 1.75 KB

sqlkit monorepo

Bun workspaces monorepo for sqlkit — a zero-dependency TypeScript query builder and repository layer for PostgreSQL.

Workspace layout

PathPackageDescription
packages/sqlkitsqlkitLibrary source, tests, and build
apps/playground@sqlkit/playgroundLocal dev app exercising the repository API

Quick start

# Start PostgreSQL
docker compose up -d
# Install dependencies
bun install
# Run playground (and sqlkit tinker) in mprocs
bun dev

Or run the playground alone:

bun run --filter @sqlkit/playground dev

Copy apps/playground/.env.example to apps/playground/.env if you need non-default database credentials.

Scripts

CommandDescription
bun devmprocs tabbed UI — playground + sqlkit tinker
bun testRun repository integration tests
bun run buildBuild sqlkit for npm (dist/)
bun run formatPrettier on library source
bun run docsGenerate Typedoc into docs/

Publishing

The publishable package lives in packages/sqlkit. Release CI builds and publishes from that workspace.

Current major version: 2.x — Repository uses a config object; see CHANGELOG.md for migration from 1.x.

Library usage docs: packages/sqlkit/README.md · API docs