Bun workspaces monorepo for sqlkit — a zero-dependency TypeScript query builder and repository layer for PostgreSQL.
| Path | Package | Description |
|---|---|---|
packages/sqlkit |
sqlkit |
Library source, tests, and build |
apps/playground |
@sqlkit/playground |
Local dev app exercising the repository API |
# Start PostgreSQL
docker compose up -d
# Install dependencies
bun install
# Run playground (and sqlkit tinker) in mprocs
bun devOr run the playground alone:
bun run --filter @sqlkit/playground devCopy apps/playground/.env.example to apps/playground/.env if you need non-default database credentials.
| Command | Description |
|---|---|
bun dev |
mprocs tabbed UI — playground + sqlkit tinker |
bun test |
Run repository integration tests |
bun run build |
Build sqlkit for npm (dist/) |
bun run format |
Prettier on library source |
bun run docs |
Generate Typedoc into docs/ |
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