nestjs-starter copilot-instructions.md

NestJS Starter — GitHub Copilot Instructions

Complete project context embedded below. Do not scan source files to re-derive what is already here.

Stack

NestJS 11 · Prisma 7 + @prisma/adapter-pg (pg Pool, no binary engine) · PostgreSQL · Redis ioredis · BullMQ · JWT (passport-jwt + argon2) · nestjs-pino · nestjs-i18n · Sentry · Swagger (non-prod only) · TypeScript 6 · Node ≥20

Directory Layout

src/
├── app/
│   ├── app.module.ts              root module
│   ├── config/                    registerAs() factories (index.ts barrel)
│   │   ├── app.config.ts          'app.*'
│   │   ├── auth.config.ts         'auth.accessToken.*' / 'auth.refreshToken.*'
│   │   ├── redis.config.ts        'redis.*'
│   │   ├── doc.config.ts          'doc.*'
│   │   └── seed.config.ts         'seed.admin.*'
│   ├── controllers/health.controller.ts
│   └── enums/app.enum.ts
├── common/
│   ├── common.module.ts           imports all infra; exports DatabaseModule + CacheModule only
│   ├── bullmq/bullmq.module.ts    shared BullMQ Redis connection
│   ├── cache/services/cache.service.ts
│   ├── database/
│   │   ├── database.module.ts     provides+exports DatabaseService, UserRepository
│   │   ├── services/database.service.ts
│   │   ├── repositories/user.repository.ts
│   │   ├── interfaces/user.interface.ts   UserEntity, CreateUserInput, UpdateUserInput
│   │   └── enums/role.enum.ts            re-exports Prisma Role as UserRole
│   ├── doc/decorators/
│   │   └── doc.api-endpoint.decorator.ts  @ApiEndpoint (only decorator for controller methods)
│   ├── request/
│   │   ├── request.module.ts      registers ThrottlerGuard → JwtAccessGuard → RolesGuard
│   │   ├── decorators/auth-user.decorator.ts    @AuthUser()
│   │   ├── decorators/public.decorator.ts       @PublicRoute()
│   │   ├── decorators/roles.decorator.ts        @AllowedRoles([...])
│   │   ├── guards/jwt-access.guard.ts
│   │   ├── guards/jwt-refresh.guard.ts
│   │   └── interfaces/request.interface.ts      IAuthUser = { userId, role }
│   └── response/
│       ├── dtos/response.success.dto.ts    ApiSuccessResponseDto<T>
│       ├── dtos/response.generic.dto.ts    ApiGenericResponseDto
│       ├── filters/response.exception.filter.ts
│       └── interceptors/response.interceptor.ts
├── modules/
│   ├── auth/                      public: login, signup, refresh
│   └── user/                      public: profile CRUD; admin: delete
└── workers/schedulers/            Cron schedulers (MidNightScheduleWorker)