/typescript-nestjs-template

Starter template for building RESTful APIs in TypeScript with NestJS

Primary LanguageTypeScriptMIT LicenseMIT

typescript-nestjs-template

A simple and idiomatic REST API boilerplate built in TypeScript with NestJS, designed for clarity, modularity and extensibility.
Designed to showcase best practices in modular architecture, request validation, documentation, and automated testing.

โœจ Features

  • ๐Ÿงฑ Modular and scalable structure
  • ๐Ÿšฆ RESTful routing with controllers and services
  • ๐Ÿ“„ Swagger documentation at /docs
  • โœ… Request validation with class-validator
  • ๐Ÿงช Unit & E2E tests with Jest and Supertest
  • ๐Ÿณ Minimal Docker support
  • ๐Ÿงฐ Designed as a reusable starter template

๐Ÿ“ฆ Stack

  • Node.js 20+
  • NestJS 10+
  • TypeScript (strict mode)
  • class-validator / class-transformer
  • Swagger via @nestjs/swagger
  • ESLint + Prettier
  • Jest + Supertest

๐Ÿš€ Getting Started

# Install dependencies
yarn install

# Run the server in watch mode
yarn start:dev