NestJS 模板项目教程

NestJS 模板项目教程

nestjs-templateScaffold quickly your next TypeScript API with this opinionated NestJS template crafted for Docker environments项目地址:https://gitcode.com/gh_mirrors/ne/nestjs-template

1. 项目的目录结构及介绍

nestjs-template/
├── src/
│   ├── app.module.ts
│   ├── main.ts
│   ├── config/
│   │   ├── environment.ts
│   ├── modules/
│   │   ├── example/
│   │   │   ├── example.module.ts
│   │   │   ├── example.service.ts
│   │   │   ├── example.controller.ts
├── test/
├── Dockerfile
├── package.json
├── tsconfig.json

目录结构说明

• src/: 源代码目录，包含所有的 TypeScript 文件。
  • app.module.ts: 应用程序的根模块。
  • main.ts: 应用程序的入口文件。
  • config/: 配置文件目录。
    • environment.ts: 环境变量配置文件。
  • modules/: 业务模块目录。
    • example/: 示例模块。
      • example.module.ts: 示例模块定义。
      • example.service.ts: 示例服务。
      • example.controller.ts: 示例控制器。
• test/: 测试文件目录。
• Dockerfile: Docker 配置文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 编译配置文件。

2. 项目的启动文件介绍

main.ts

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

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

启动文件说明

• main.ts 是 NestJS 应用程序的入口文件。
• 使用 NestFactory.create 方法创建应用程序实例。
• 通过 app.listen 方法启动服务器，监听端口 3000。

3. 项目的配置文件介绍

environment.ts

export default () => ({
  port: parseInt(process.env.PORT, 10) || 3000,
  database: {
    host: process.env.DATABASE_HOST || 'localhost',
    port: parseInt(process.env.DATABASE_PORT, 10) || 5432,
  },
});

配置文件说明

• environment.ts 文件用于加载和配置环境变量。
• 通过 process.env 读取环境变量，并提供默认值。
• 配置包括端口和数据库连接信息。

以上是基于 Saluki/nestjs-template 项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。

nestjs-templateScaffold quickly your next TypeScript API with this opinionated NestJS template crafted for Docker environments项目地址:https://gitcode.com/gh_mirrors/ne/nestjs-template