API Reference
Rockets Core API
nestjs-user
README

Rockets NestJS User

A module for managing a basic User entity, including controller with full CRUD, DTOs, sample data factory and seeder.

Project

NPM Latest (opens in a new tab) NPM Downloads (opens in a new tab) GH Last Commit (opens in a new tab) GH Contrib (opens in a new tab) NestJS Dep (opens in a new tab)

Installation

yarn add @concepta/nestjs-user

Usage

// ...
import { TypeOrmExtModule } from '@concepta/nestjs-typeorm-ext';
import { UserModule } from '@concepta/nestjs-user';
import { CrudModule } from '@concepta/nestjs-crud';
 
@Module({
  imports: [
    TypeOrmExtModule.forRoot({
      type: 'postgres',
      url: 'postgres://user:pass@localhost:5432/postgres',
    }),
    CrudModule.forRoot({}),
    UserModule.forRoot({}),
  ],
})
export class AppModule {}

Configuration

Seeding

Configurations specific to (optional) database seeding.

ENV

Configurations available via environment.

VariableTypeDefault
USER_MODULE_SEEDER_AMOUNT<number>50number of additional users to create
USER_MODULE_SEEDER_SUPERADMIN_USERNAME<string>'superadmin'super admin username