Project scaffolding in NestJS - Step-by-Step Execution

Concept Flow - Project scaffolding

Run nest new command

↓

CLI creates folder structure

↓

Generate main files: app.module.ts, main.ts

↓

Install dependencies

↓

Project ready to run

The NestJS CLI creates a new project folder with all needed files and dependencies so you can start coding quickly.

Execution Sample

NestJS

nest new project-name
cd project-name
npm run start

Creates a new NestJS project, moves into its folder, and starts the development server.

Execution Table

Step	Action	Result	Files/Folders Created
1	Run 'nest new project-name'	CLI scaffolds project	project-name/ folder with src/, test/, package.json, tsconfig.json, etc.
2	CLI installs dependencies	node_modules added	node_modules/ folder with packages
3	Project folder structure ready	Main files created	src/app.module.ts, src/main.ts, etc.
4	Run 'npm run start'	NestJS server starts	Console shows 'Listening on port 3000'
5	Access http://localhost:3000	Default welcome message shown	No file change, server response

💡 Project scaffolding completes after dependencies install and main files are created.

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	After Step 4
project-folder	none	created	created	created with files	created with files
dependencies	none	none	installed	installed	installed
server-status	off	off	off	off	running

Key Moments - 3 Insights

Why do we run 'npm install' automatically during scaffolding?

The CLI installs dependencies right after creating files so you don't have to do it manually, as shown in execution_table step 2.

What files are essential for the NestJS app to start?

The main files are src/main.ts (entry point) and src/app.module.ts (root module), created in step 3 of the execution_table.

Why does the server start only after 'npm run start'?

Because the server code runs only when you execute the start script, as shown in step 4 where server-status changes to running.

Visual Quiz - 3 Questions

Look at the execution_table, what is the state of 'server-status' after step 3?

A starting

B off

C running

D error

💡 Hint

Check the variable_tracker row for 'server-status' after step 3.

At which step does the CLI install dependencies?

A Step 3

B Step 1

C Step 2

D Step 4

💡 Hint

Look at the 'Action' and 'Result' columns in execution_table for dependency installation.

If you skip 'npm run start', what will happen?

A Server will not run

B Server will start automatically

C Project files won't be created

D Dependencies won't install

💡 Hint

Refer to execution_table step 4 and variable_tracker for 'server-status'.

Concept Snapshot

NestJS Project Scaffolding:
- Use 'nest new project-name' to create a new project folder
- CLI generates folder structure and main files
- Dependencies install automatically
- Run 'npm run start' to launch the server
- Access localhost:3000 to see the app running

Full Transcript

Project scaffolding in NestJS starts by running the command 'nest new project-name'. This command creates a new folder with all necessary files and folders like src/, test/, package.json, and configuration files. The CLI then installs all required dependencies automatically. After scaffolding, the project is ready to run. Running 'npm run start' launches the NestJS server, which listens on port 3000. Visiting http://localhost:3000 shows the default welcome message. Variables like project-folder and dependencies change state during these steps, while the server-status changes from off to running only after starting the server.

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