Skip to content

sqlkit-dev/sqlkit

Repository files navigation

sqlkit monorepo

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

Workspace layout

Path Package Description
packages/sqlkit sqlkit Library source, tests, and build
apps/playground @sqlkit/playground Local 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

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/

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

About

sqlkit is a zero-dependency lightweight and expressive SQL query builder and repository layer for TypeScript with PostgreSQL support.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors