NestJS Template

Nest Logo

NestJS TypeScript ESLint Prettier pnpm

Template for creating a NestJS app with TypeScript, ESLint, and Prettier. Pre-configured with Jest and supertest for testing.

๐Ÿš€ Using this template

  1. Create your project based on this template:

    • a) If you want to create a GitHub repository, we would recommend to use the GitHub "Use this template" button and clone your newly created repository
    • b) If you don't want to create a GitHub repository, you can use the degit tool to clone this repository without the Git history:
      npx degit JPerezC92/nestjs-template#main my-nextjs-app
  2. Start the app:

    cd my-nextjs-app    
    pnpm install
    pnpm start:dev
  3. Start coding!

๐Ÿงช Testing

Unit Testing

This template uses Jest for unit testing. To run the tests:

pnpm test:watch

E2E Testing

This template uses SuperTest for E2E testing. To run the tests:

pnpm test:e2e

๐Ÿ“ฆ Building for production

To build the app for production:

pnpm build
pnpm start:prod

๐Ÿงน Linting

To lint the app:

pnpm lint

๐Ÿ“ Formatting

To format the app:

pnpm format

๐Ÿ“š Documentation