Quick Start

Read the intro

Prerequisites

Before proceeding, make sure you have a typescript project and access to a postgresql database.

You will need the database connection URL available as an environment variable called DB_URL. (You can configure the expected name in @/db/index.ts and drizzle.config.ts)

With Shadcn

Caution

Experimental

Be aware that the shadcn cli is intended for use with frontend frameworks. It doesn’t have a great way to handle when wunshot modules require changes to a core model. It is recommended to always commit changes before adding a module and to investigate any overwrites to the core models carefully.

1. Add the registry to your components.json

   components.json

     // ...
     "registries": {
       "@wunshot": "https://registry.wunshot.dev/{name}.json"
     }

2. Use your preferred package manager with the shadcn cli

   pnpm

     pnpm dlx shadcn@latest add @wunshot/init

   npm

     npx shadcn@latest add @wunshot/init

   yarn

     yarn shadcn@latest add @wunshot/init

   bun

     bunx --bun shadcn@latest add @wunshot/init

   Danger

   There is known a bug that @/db/models/activities/schemas uses an incorrect import path for the users and usersArchive schemas. For now, you will need to manually update it to import { users, usersArchive } from "@/db/models/users/schemas".

   Tip

   You may need to update the driver based on your database provider. The node-postgres driver is used by default. You can configure the driver in @/db/index.ts

3. Install dev dependencies

   pnpm

     pnpm add -D drizzle-kit @types/pg

   npm

     npm i -D drizzle-kit @types/pg

   yarn

     yarn add -D drizzle-kit @types/pg

   bun

     bun add -D drizzle-kit @types/pg

4. Add scripts to your package.json

   pnpm

   package.json

   {
     // ...
     "scripts": {
       // ...
       "db": "drizzle-kit --config ./src/db/drizzle.config.ts",
       "db:check": "pnpm run db -- check",
       "db:generate": "pnpm run db -- generate",
       "db:migrate": "pnpm run db -- migrate",
       "db:push": "pnpm run db -- push",
       "db:studio": "pnpm run db -- studio"
     }
     // ...
   }

   npm

   package.json

   {
     // ...
     "scripts": {
       // ...
       "db": "drizzle-kit --config ./src/db/drizzle.config.ts",
       "db:check": "pnpm run db -- check",
       "db:generate": "npm run db -- generate",
       "db:migrate": "npm run db -- migrate",
       "db:push": "npm run db -- push",
       "db:studio": "npm run db -- studio"
     }
     // ...
   }

   yarn

   package.json

   {
     // ...
     "scripts": {
       // ...
       "db": "drizzle-kit --config ./src/db/drizzle.config.ts",
       "db:check": "pnpm run db -- check",
       "db:generate": "yarn run db -- generate",
       "db:migrate": "yarn run db -- migrate",
       "db:push": "yarn run db -- push",
       "db:studio": "yarn run db -- studio"
     }
     // ...
   }

   bun

   package.json

   {
     // ...
     "scripts": {
       // ...
       "db": "bun run --bun drizzle-kit --config ./src/db/drizzle.config.ts",
       "db:check": "pnpm run db -- check",
       "db:generate": "bun run db -- generate",
       "db:migrate": "bun run db -- migrate",
       "db:push": "bun run db -- push",
       "db:studio": "bun run db -- studio"
     }
     // ...
   }

5. Generate and apply migrations

   pnpm

     pnpm run db:generate && pnpm run db:migrate

   npm

     npm run db:generate && npm run db:migrate

   yarn

     yarn run db:generate && yarn run db:migrate

   bun

     bun run db:generate && bun run db:migrate