TypeScript (NestJS)

The TypeScript template uses NestJS, a progressive Node.js framework for building efficient and scalable server-side applications.

Overview

Component	Technology
Framework	NestJS 10
ORM	TypeORM
Validation	class-validator
Documentation	Swagger/OpenAPI
Testing	Jest

Quick Start


# Create a new TypeScript service
apso server new my-api --template typescript
 
# Navigate to project
cd my-api
 
# Install dependencies
npm install
 
# Start development server
npm run dev

Project Structure


my-api/
├── src/
│   ├── entities/               # TypeORM entities
│   │   ├── project.entity.ts
│   │   └── task.entity.ts
│   ├── modules/                # NestJS modules
│   │   ├── projects/
│   │   │   ├── projects.module.ts
│   │   │   ├── projects.controller.ts
│   │   │   ├── projects.service.ts
│   │   │   └── dto/
│   │   └── tasks/
│   ├── extensions/             # Your custom code
│   │   ├── controllers/
│   │   ├── services/
│   │   └── modules/
│   ├── common/                 # Shared utilities
│   │   ├── decorators/
│   │   ├── guards/
│   │   └── interceptors/
│   ├── config/                 # Configuration
│   ├── app.module.ts
│   └── main.ts
├── test/                       # E2E tests
├── .apsorc                     # APSO schema
├── package.json
└── tsconfig.json

Key Technologies

NestJS

NestJS provides a robust architecture with:

Modules for code organization
Controllers for HTTP handling
Services for business logic
Dependency injection
Middleware and guards

TypeORM

Type-safe database access:

Entity definitions
Migrations
Query builder
Repository pattern

Class-Validator

Request validation with decorators:


import { IsString, IsNotEmpty, MaxLength } from 'class-validator';
 
export class CreateProjectDto {
  @IsString()
  @IsNotEmpty()
  @MaxLength(200)
  name: string;
 
  @IsString()
  @IsOptional()
  description?: string;
}

Configuration

Environment Variables


# .env
DATABASE_URL=postgresql://user:pass@localhost:5432/db
JWT_SECRET=your-secret-key
PORT=3001
NODE_ENV=development

TypeORM Configuration


// src/config/database.config.ts
export const databaseConfig = {
  type: 'postgres',
  url: process.env.DATABASE_URL,
  entities: [__dirname + '/../entities/*.entity{.ts,.js}'],
  migrations: [__dirname + '/../migrations/*{.ts,.js}'],
  synchronize: process.env.NODE_ENV === 'development',
};

Commands

Command	Description
`npm run dev`	Start with hot reload
`npm run build`	Build for production
`npm start`	Start production server
`npm test`	Run unit tests
`npm run test:e2e`	Run E2E tests
`npm run lint`	Lint code

Features

Auto-Generated

Entity definitions with TypeORM decorators
CRUD controllers with validation
Services with repository injection
DTOs for create/update operations
Swagger documentation
Basic authentication guards

Customizable

Add custom endpoints in extensions
Override generated services
Add middleware and guards
Integrate external services