ConfigModule setup in NestJS - Mini Project: Build & Apply

ConfigModule setup

📖 Scenario: You are building a NestJS application that needs to manage configuration settings safely and efficiently.

🎯 Goal: Set up the ConfigModule in a NestJS app to load environment variables and make them available throughout the app.

📋 What You'll Learn

Create a configuration file with environment variables

Import ConfigModule in the root module

Configure ConfigModule to load environment variables globally

Use ConfigService to access configuration values

💡 Why This Matters

🌍 Real World

Managing environment variables is essential for configuring apps differently in development, testing, and production without changing code.

💼 Career

Understanding ConfigModule setup is important for backend developers working with NestJS to build scalable and maintainable applications.

1

Create a .env file with environment variables

Create a file named .env in the project root with these exact entries:
DATABASE_HOST=localhost
DATABASE_PORT=5432
API_KEY=12345

NestJS

# Create a .env file with the specified environment variables

Hint

The .env file contains key-value pairs for configuration.

2

Import ConfigModule in AppModule

In app.module.ts, import ConfigModule from @nestjs/config and add ConfigModule.forRoot() to the imports array of @Module.

NestJS

import { Module } from '@nestjs/common';
// Your code here

Hint

Use ConfigModule.forRoot() to load environment variables automatically.

3

Configure ConfigModule to be global

Modify the ConfigModule.forRoot() call in app.module.ts to include { isGlobal: true } so the configuration is available throughout the app.

NestJS

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';

@Module({
  imports: [
    // Add isGlobal option here
  ],
})
export class AppModule {}

Hint

Setting isGlobal: true makes ConfigModule available everywhere without importing again.

4

Use ConfigService to access environment variables

In any service, inject ConfigService from @nestjs/config in the constructor and use this.configService.get('DATABASE_HOST') to access the DATABASE_HOST value.

NestJS

import { Injectable } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';

@Injectable()
export class DatabaseService {
  constructor(private configService: ConfigService) {
    // Your code here
  }
}

Hint

Inject ConfigService in the constructor and call get() with the environment variable name.

Practice

1. What is the main purpose of ConfigModule in a NestJS application?

easy

A. To manage application settings using environment variables

B. To handle HTTP requests and responses

C. To connect to a database

D. To create middleware for logging

Solution

1. Step 1: Understand ConfigModule role

   The ConfigModule is designed to load and manage configuration settings, often from environment variables.

2. Step 2: Compare with other options

   Options A, B, and D relate to other parts of NestJS like database connections, HTTP handling, and middleware, not configuration management.

3. Final Answer:

   To manage application settings using environment variables -> Option A

4. Quick Check:

   ConfigModule = Manage app settings [OK]

Hint: ConfigModule is for app settings, not HTTP or DB [OK]

Common Mistakes:

• Confusing ConfigModule with database modules
• Thinking ConfigModule handles HTTP requests
• Assuming ConfigModule creates middleware

2. Which is the correct way to import ConfigModule globally in the root module?

easy

A. ConfigModule.register({ global: true })

B. ConfigModule.forFeature({ isGlobal: true })

C. ConfigModule.forRoot({ isGlobal: true })

D. ConfigModule.global()

Solution

1. Step 1: Recall ConfigModule global setup syntax

   To make ConfigModule available app-wide, use forRoot() with isGlobal: true.

2. Step 2: Check other options for correctness

   forFeature() is for scoped configs, register() and global() are not valid methods here.

3. Final Answer:

   ConfigModule.forRoot({ isGlobal: true }) -> Option C

4. Quick Check:

   Global config = forRoot + isGlobal true [OK]

Hint: Use forRoot with isGlobal true for global config [OK]

Common Mistakes:

• Using forFeature instead of forRoot
• Trying to use non-existent methods like global()
• Confusing register with forRoot

3. Given this code snippet in a NestJS service:

constructor(private configService: ConfigService) {}

getDbHost() {
  return this.configService.get('DATABASE_HOST');
}

What will getDbHost() return if DATABASE_HOST is set to "localhost" in the environment?

medium

A. Throws an error

B. undefined

C. null

D. "localhost"

Solution

1. Step 1: Understand ConfigService.get behavior

   The get method returns the value of the environment variable if set, here 'localhost'.

2. Step 2: Check environment variable presence

   Since DATABASE_HOST is set to 'localhost', the method returns that string, not undefined or null.

3. Final Answer:

   "localhost" -> Option D

4. Quick Check:

   Env var set = get returns value [OK]

Hint: get() returns env value if set, else undefined [OK]

Common Mistakes:

• Assuming get returns null if variable exists
• Expecting an error if variable is missing
• Confusing undefined with null

4. Identify the error in this NestJS module setup:

@Module({
  imports: [ConfigModule.forRoot({ isGlobal: true })],
  providers: [ConfigService],
})
export class AppModule {}

medium

A. ConfigService should not be listed in providers when ConfigModule is global

B. Missing import of ConfigService from '@nestjs/config'

C. forRoot() should not have isGlobal option

D. ConfigModule should be imported in controllers, not imports

Solution

1. Step 1: Understand global ConfigModule behavior

   When isGlobal: true is set, ConfigService is automatically provided app-wide, no need to add it manually.

2. Step 2: Check other options for validity

   Importing ConfigService is not mandatory in module file, forRoot supports isGlobal, and ConfigModule belongs in imports array.

3. Final Answer:

   ConfigService should not be listed in providers when ConfigModule is global -> Option A

4. Quick Check:

   Global ConfigModule auto-provides ConfigService [OK]

Hint: Don't add ConfigService to providers if ConfigModule is global [OK]

Common Mistakes:

• Adding ConfigService to providers unnecessarily
• Thinking isGlobal is invalid option
• Placing ConfigModule in controllers array

5. You want to load a custom configuration file named custom.env using ConfigModule and make it global. Which setup is correct?

hard

A. ConfigModule.forRoot({ envFileName: 'custom.env', global: true })

B. ConfigModule.forRoot({ envFilePath: 'custom.env', isGlobal: true })

C. ConfigModule.forFeature({ envFilePath: 'custom.env', isGlobal: true })

D. ConfigModule.register({ envFilePath: 'custom.env', isGlobal: true })

Solution

1. Step 1: Identify correct option names for ConfigModule

   The correct option to specify a custom env file is envFilePath, and to make it global use isGlobal: true inside forRoot().

2. Step 2: Eliminate incorrect options

   envFileName and global are invalid option names; forFeature and register are not used for global config loading.

3. Final Answer:

   ConfigModule.forRoot({ envFilePath: 'custom.env', isGlobal: true }) -> Option B

4. Quick Check:

   Custom env + global = envFilePath + isGlobal true [OK]

Hint: Use envFilePath and isGlobal in forRoot for custom global config [OK]

Common Mistakes:

• Using envFileName instead of envFilePath
• Trying to use forFeature for global config
• Using register instead of forRoot