Project scaffolding in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is project scaffolding in NestJS?

Project scaffolding in NestJS means creating the basic folder and file structure automatically to start a new app quickly.

beginner

Which command creates a new NestJS project with default structure?

The command nest new project-name creates a new NestJS project with all basic files and folders set up.

beginner

Name three main folders created by NestJS scaffolding.

The main folders are src (source code), test (tests), and node_modules (dependencies).

beginner

Why is using NestJS CLI for scaffolding helpful?

It saves time, ensures best practices, and sets up a working project with correct configs and dependencies.

beginner

What files are included in the NestJS scaffold for app configuration?

Files like main.ts (app entry), app.module.ts (root module), and package.json (project info) are included.

Which command do you run to create a new NestJS project?

A nest generate project

B npm start

C nest new my-app

D node app.js

The nest new my-app command scaffolds a new NestJS project with default structure.

What folder contains the main source code in a NestJS scaffolded project?

A dist

B lib

C bin

D src

The src folder holds the main source code files in NestJS projects.

Which file is the entry point of a NestJS application?

A main.ts

B index.html

C app.module.ts

D server.js

main.ts is the entry point where the NestJS app starts running.

What benefit does NestJS CLI provide when scaffolding a project?

A Sets up project with best practices

B Creates random files

C Deletes old projects

D Runs the app automatically

NestJS CLI scaffolds projects following best practices and correct setup.

Which file contains project dependencies in a NestJS scaffold?

A tsconfig.json

B package.json

C README.md

D main.ts

package.json lists all dependencies and scripts for the project.

Explain what happens when you run nest new to scaffold a project.

Think about the steps the CLI automates for you.

Describe the purpose of the src folder in a NestJS scaffolded project.

Where do you write your NestJS code?

Practice

1. What is the main purpose of using nest new project-name in NestJS?

easy

A. To create a new NestJS project with a ready-to-use structure

B. To start the NestJS development server

C. To install NestJS dependencies globally

D. To generate a new module inside an existing project

Solution

1. Step 1: Understand the command nest new project-name

   This command is used to create a new NestJS project folder with all necessary files and folders set up.

2. Step 2: Identify the purpose of scaffolding

   Scaffolding means generating a basic project structure automatically to save time and follow best practices.

3. Final Answer:

   To create a new NestJS project with a ready-to-use structure -> Option A

4. Quick Check:

   Project scaffolding = create new project structure [OK]

Hint: Remember: 'nest new' creates a fresh project folder fast [OK]

Common Mistakes:

• Confusing 'nest new' with starting the server
• Thinking it installs global packages only
• Mixing it up with generating modules inside projects

2. Which of the following is the correct syntax to create a new NestJS project named my-app?

easy

A. nest create my-app

B. nest new my-app

C. nest generate project my-app

D. nest init my-app

Solution

1. Step 1: Recall the NestJS CLI command for new projects

   The official command to scaffold a new project is nest new project-name.

2. Step 2: Match the correct syntax

   Among the options, only nest new my-app matches the correct CLI command format.

3. Final Answer:

   nest new my-app -> Option B

4. Quick Check:

   Correct CLI syntax = nest new [OK]

Hint: Use 'nest new' exactly to scaffold projects [OK]

Common Mistakes:

• Using 'nest create' instead of 'nest new'
• Trying 'nest generate project' which is invalid
• Confusing 'nest init' with project creation

3. After running nest new sample-app, which folder structure will you see inside sample-app?

medium

A. src/, node_modules/, package.json, nest-cli.json

B. app/, config/, public/, package-lock.json

C. controllers/, models/, views/, app.js

D. lib/, bin/, config/, README.md

Solution

1. Step 1: Recall default NestJS project folders

   A new NestJS project contains a src/ folder for source code, node_modules/ for dependencies, and config files like package.json and nest-cli.json.

2. Step 2: Compare options with known structure

   src/, node_modules/, package.json, nest-cli.json matches the expected NestJS scaffold structure; others list unrelated folders or files.

3. Final Answer:

   src/, node_modules/, package.json, nest-cli.json -> Option A

4. Quick Check:

   Default NestJS scaffold = src and config files [OK]

Hint: Look for src folder and package.json in new projects [OK]

Common Mistakes:

• Expecting MVC folders like controllers, models, views
• Confusing with frontend project structures
• Looking for app.js which is not used in NestJS

4. You ran nest new myproject but got an error: Command 'nest' not found. What is the most likely fix?

medium

A. Rename the folder to 'nest' before running the command

B. Run nest new inside an existing NestJS project

C. Use npm start instead of nest new

D. Install Nest CLI globally using npm i -g @nestjs/cli

Solution

1. Step 1: Understand the error meaning

   The error means the system does not recognize the nest command, likely because the Nest CLI is not installed globally.

2. Step 2: Identify the correct fix

   Installing the Nest CLI globally with npm i -g @nestjs/cli makes the nest command available anywhere.

3. Final Answer:

   Install Nest CLI globally using npm i -g @nestjs/cli -> Option D

4. Quick Check:

   Missing CLI = install globally [OK]

Hint: Install Nest CLI globally to use 'nest' command [OK]

Common Mistakes:

• Trying to run 'nest new' inside a non-NestJS folder
• Using npm start which runs app, not CLI
• Renaming folders instead of installing CLI

5. You want to create a new NestJS project but customize the package manager to use yarn instead of npm. Which command should you run?

hard

A. nest new myapp --package yarn

B. nest new myapp --use-yarn

C. nest new myapp --package-manager yarn

D. nest new myapp --pm yarn

Solution

1. Step 1: Recall NestJS CLI option for package manager

   The Nest CLI supports the option --package-manager to specify which package manager to use during project creation.

2. Step 2: Match the correct option syntax

   nest new myapp --package-manager yarn uses the correct full option --package-manager yarn. Other options are invalid or incomplete.

3. Final Answer:

   nest new myapp --package-manager yarn -> Option C

4. Quick Check:

   Use --package-manager to set yarn [OK]

Hint: Use --package-manager option to pick yarn or npm [OK]

Common Mistakes:

• Using shorthand or incorrect flags like --pm or --use-yarn
• Assuming default is yarn without specifying
• Trying --package instead of --package-manager