52 lines (35 loc) · 1.5 KB

WARP.md

This file provides guidance to WARP (warp.dev) when working with code in this repository.

Common Commands

Development

Install dependencies: pnpm install
Run in development mode (with watch): pnpm run start:dev
Run in production mode: pnpm run start:prod
Build the project: pnpm run build

Testing

Run unit tests: pnpm run test
Run end-to-end tests: pnpm run test:e2e
Run tests with coverage: pnpm run test:cov

Linting and Formatting

Lint files: pnpm run lint
Format files: pnpm run format

Database

Generate database migrations: pnpm run migrate.dev
Run database migrations: pnpm run migrate.prod
Seed the database: pnpm run db.seed
Open Drizzle Studio: pnpm run studio

Code Architecture

This project is a monolithic API built with the NestJS framework.

Key Technologies

Framework: NestJS
Database ORM: Drizzle ORM with PostgreSQL
Validation: nestjs-zod for request and response validation.
Authentication: Passport.js with JWT and Google OAuth.
Package Manager: pnpm

Project Structure

src/: Contains the main application source code, organized by NestJS modules.
- main.ts: The application entry point.
db/: Contains database-related files, including Drizzle ORM schema and migrations.
test/: Contains end-to-end tests.
drizzle.config.ts: Configuration for Drizzle ORM.
nest-cli.json: Configuration for the NestJS CLI.