Installation

Prerequisites

npm install viborm

Or with other package managers:

pnpm add viborm
yarn add viborm
bun add viborm

Install the driver for your database:

npm install pg

npm install mysql2

npm install better-sqlite3

Ensure your tsconfig.json has strict mode enabled for full type inference:

{
  "compilerOptions": {
    "strict": true,
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler"
  }
}

A typical VibORM project structure:

src/
├── db/
│   ├── schema.ts      # Model definitions
│   ├── client.ts      # Client initialization
│   └── index.ts       # Re-exports
├── ...

Build your first schema in 5 minutes