Toidicode.com

Toidicode.com

BASIC TO ADVANCE

Bài 3: Cài đặt NestJS và tạo project đầu tiên

Tiếp tục với series, sau khi đã nắm được những phần TypeScript cần thiết, bài này mình sẽ hướng dẫn mọi người cài đặt NestJS và tạo project đầu tiên: project TaskFlow API mà chúng ta sẽ xây dựng dần trong suốt series.

1. Cài đặt Node.js và Nest CLI.

Nest CLI (phần tạo project và sinh code) cần Node.js 22.22.3, 24.15 hoặc 26 trở lên. Các bạn cài bản Node.js 24 LTS từ nodejs.org rồi kiểm tra lại:

node -v
# v24.22.3

Tiếp theo cài Nest CLI, công cụ dòng lệnh giúp tạo project, sinh code, chạy và build ứng dụng:

npm i -g @nestjs/cli
nest --version
# 12.0.13

Lưu ý: Nếu không muốn cài global, các bạn có thể thay nest bằng npx @nestjs/cli@latest ở các lệnh bên dưới.

2. Tạo project TaskFlow API.

Để tạo project mới, các bạn sử dụng lệnh nest new với cú pháp như sau:

nest new taskflow-api

CLI sẽ hỏi lần lượt các câu sau, mình chọn như này:

  • Which package manager would you ❤️ to use?: chọn npm.
  • Would you like to set up @nestjs/observe ...? (Y/n): gõ n. Đây là dịch vụ theo dõi ứng dụng (cần tài khoản), chưa cần với series.
  • Which module system would you like to use?: chọn ESM (ES Modules) [ with vitest ] (mặc định). Chọn CJS sẽ được project CommonJS dùng Jest.

Nếu không muốn trả lời từng câu, các bạn truyền luôn option, khi đó ESM là mặc định:

nest new taskflow-api --package-manager npm --no-observe

CLI sẽ tạo thư mục taskflow-api, sinh các file, cài package và khởi tạo git repository. Project mới luôn bật chế độ strict của TypeScript.

Ngoài code, CLI còn sinh file AGENTS.md (hướng dẫn cho các AI coding agent). Không dùng thì các bạn có thể xoá đi, trong project của series mình đã xoá.

3. Cấu trúc project.

Project vừa tạo có cấu trúc như sau (bỏ qua node_modules, AGENTS.md đã xoá):

taskflow-api/
├── src/
│   ├── app.controller.spec.ts
│   ├── app.controller.ts
│   ├── app.module.ts
│   ├── app.service.ts
│   └── main.ts
├── test/
│   └── app.e2e-spec.ts
├── .gitattributes
├── .gitignore
├── .oxlintrc.json
├── .prettierrc
├── README.md
├── nest-cli.json
├── package-lock.json
├── package.json
├── tsconfig.build.json
├── tsconfig.json
├── vitest.config.e2e.ts
└── vitest.config.ts

src/main.ts là file chạy đầu tiên của ứng dụng:

- src/main.ts

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module.js';

async function bootstrap() {
    const app = await NestFactory.create(AppModule);
    await app.listen(process.env.PORT ?? 3000);
}
await bootstrap();

NestFactory.create(AppModule) tạo ứng dụng từ module gốc AppModule, rồi app.listen() lắng nghe request ở cổng trong biến môi trường PORT, không có thì là 3000. Để ý import có đuôi .js như mình đã nói ở Bài 2.

- src/app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller.js';
import { AppService } from './app.service.js';

@Module({
    imports: [],
    controllers: [AppController],
    providers: [AppService],
})
export class AppModule {}

Đây là module gốc, khai báo controller và service của ứng dụng. AppController có một route GET / gọi sang AppService.getHello(), giống ví dụ ở Bài 1. Module, controller và provider mình sẽ giải thích chi tiết ở Bài 4, 5 và 6.

Các file còn lại:

  • *.spec.ts và test/app.e2e-spec.ts: unit test và e2e test chạy bằng Vitest (cấu hình trong vitest.config*.ts), mình sẽ nói ở Bài 34.
  • tsconfig.json: cấu hình TypeScript, tsconfig.build.json dùng khi build (bỏ qua file test).
  • nest-cli.json: cấu hình cho Nest CLI, VD sourceRoot là src.
  • .oxlintrc.json, .prettierrc: cấu hình cho oxlint và Prettier (phần 5).

4. Chạy ứng dụng.

Các bạn cd vào thư mục project và chạy:

cd taskflow-api
npm run start

Lệnh này compile TypeScript sang thư mục dist rồi chạy ứng dụng. Log in ra cho biết module nào đã khởi tạo và route nào đã được đăng ký:

[Nest] 93  - 11/15/2026, 5:31:47 AM     LOG [NestFactory] Starting Nest application...
[Nest] 93  - 11/15/2026, 5:31:48 AM     LOG [InstanceLoader] AppModule dependencies initialized +18ms
[Nest] 93  - 11/15/2026, 5:31:48 AM     LOG [RoutesResolver] AppController {/}: +14ms
[Nest] 93  - 11/15/2026, 5:31:48 AM     LOG [RouterExplorer] Mapped {/, GET} route +5ms
[Nest] 93  - 11/15/2026, 5:31:48 AM     LOG [NestApplication] Nest application successfully started +5ms

Mở terminal khác và gọi thử:

curl http://localhost:3000
# Hello World!

curl http://localhost:3000/abc
# {"message":"Cannot GET /abc","error":"Not Found","statusCode":404}

Route không tồn tại, NestJS tự trả về lỗi 404 dạng JSON.

Khi đang viết code, các bạn nên dùng npm run start:dev (chế độ watch): mỗi lần lưu file, ứng dụng tự compile và khởi động lại. Ấn Ctrl + C để dừng lệnh cũ rồi chạy:

npm run start:dev

VD: Mình sẽ đổi lời chào trong src/app.service.ts.

- src/app.service.ts

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

@Injectable()
export class AppService {
    getHello(): string {
        return 'Xin chào TaskFlow API!';
    }
}

Lưu file, terminal in ra File change detected. Starting incremental compilation... và ứng dụng khởi động lại:

curl http://localhost:3000
# Xin chào TaskFlow API!

Lưu ý: Hai file test src/app.controller.spec.ts và test/app.e2e-spec.ts đang kiểm tra chuỗi 'Hello World!', các bạn đổi chuỗi đó thành 'Xin chào TaskFlow API!' để npm test và npm run test:e2e vẫn chạy đúng.

5. Kiểm tra code với oxlint và Prettier.

Project mới có sẵn hai công cụ: oxlint để tìm lỗi trong code (linter, thay cho ESLint) và Prettier để định dạng code (formatter). Mỗi công cụ có một script:

npm run lint     # oxlint kiểm tra src/ và test/
npm run format   # Prettier định dạng lại các file .ts

VD: Bỏ chữ await ở dòng cuối src/main.ts (chỉ còn bootstrap();) rồi chạy npm run lint:

  x typescript(no-floating-promises): Promises must be awaited, add void operator to ignore.
   ,-[src/main.ts:8:1]
 7 | }
 8 | bootstrap();
   : ^^^^^|^^^^^^
   :      `-- This unhandled promise-like value has type `Promise<void>`.
   `----

Found 0 warnings and 1 error.

Rule no-floating-promises (bật trong .oxlintrc.json) báo lỗi khi gọi hàm async mà quên await, một lỗi rất hay gặp. Các bạn thêm lại await để hết lỗi.

Với Prettier, code do CLI sinh ra thụt lề 2 dấu cách. Để giống các ví dụ trong series, mình thêm option tabWidth:

- .prettierrc

{
  "singleQuote": true,
  "trailingComma": "all",
  "tabWidth": 4
}

Rồi chạy npm run format, các file trong src và test sẽ được thụt lề 4 dấu cách. Nên chạy npm run lint và npm run format trước mỗi lần commit.

6. Sinh code với nest generate.

Thay vì tự tạo file, các bạn có thể dùng nest generate (viết tắt nest g) với cú pháp như sau:

nest g <schematic> <name> [options]

Trong đó:

  • schematic là loại thành phần cần sinh: module (mo), controller (co), service (s), resource (res), pipe, guard... Xem đủ danh sách bằng nest g --help.
  • name là tên thành phần.
  • options hay dùng: --dry-run (-d) chỉ in ra những gì sẽ thay đổi mà không ghi file, --no-spec không sinh file test, --flat không tạo thư mục riêng, --format format file vừa sinh bằng Prettier theo .prettierrc của project.

VD: Xem trước lệnh tạo module và controller cho project với --dry-run.

nest g module projects --dry-run
# CREATE src/projects/projects.module.ts (85 bytes)
# UPDATE src/app.module.ts (339 bytes)
# Dry run enabled. No files written to disk.

nest g controller projects --dry-run
# CREATE src/projects/projects.controller.spec.ts (509 bytes)
# CREATE src/projects/projects.controller.ts (105 bytes)
# UPDATE src/app.module.ts (353 bytes)
# Dry run enabled. No files written to disk.

CLI không chỉ tạo file trong src/projects mà còn tự đăng ký vào module gần nhất (UPDATE src/app.module.ts). File sinh ra mặc định thụt lề 2 dấu cách: thêm --format vào lệnh để có ngay 4 dấu cách, hoặc chạy npm run format sau khi generate. Bài sau chúng ta sẽ chạy thật các lệnh này.

7. Lời kết.

Như vậy mình đã hướng dẫn mọi người cài đặt NestJS và tạo project TaskFlow API đầu tiên: cài Nest CLI, tạo project ESM với nest new, tìm hiểu cấu trúc project, chạy ứng dụng với start:dev, dùng oxlint, Prettier và nest generate. Bài sau mình sẽ giới thiệu về module trong NestJS và tạo ProjectsModule, TasksModule cho TaskFlow API.

Đăng ký nhận tin.

Chúng tôi chỉ gửi tối đa 2 lần trên 1 tháng. Tuyên bố không spam mail!

Vũ Thanh Tài

About author
The best way to learn is to share
Xem tất cả bài đăng

0 Comments

Bài viết chưa có ai bình luận, hãy là người đầu tiên đi bạn!

Bình luận

Captcha