NestJS 项目教程

NestJS 项目教程

nestjsNestJS MikroORM integration项目地址:https://gitcode.com/gh_mirrors/nes/nestjs

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

nestjs-project/
├── src/
│   ├── app.module.ts
│   ├── main.ts
│   ├── config/
│   │   ├── database.config.ts
│   │   └── app.config.ts
│   ├── controllers/
│   │   └── app.controller.ts
│   ├── services/
│   │   └── app.service.ts
│   └── entities/
│       └── user.entity.ts
├── test/
│   └── app.e2e-spec.ts
├── package.json
├── tsconfig.json
└── nest-cli.json

目录结构说明：

• src/：项目的主要源代码目录。
  • app.module.ts：应用程序的根模块。
  • main.ts：应用程序的入口文件。
  • config/：配置文件目录。
    • database.config.ts：数据库配置文件。
    • app.config.ts：应用程序配置文件。
  • controllers/：控制器目录。
    • app.controller.ts：应用程序的控制器。
  • services/：服务目录。
    • app.service.ts：应用程序的服务。
  • entities/：实体目录。
    • user.entity.ts：用户实体。
• test/：测试目录。
  • app.e2e-spec.ts：端到端测试文件。
• package.json：项目的依赖和脚本配置文件。
• tsconfig.json：TypeScript 配置文件。
• nest-cli.json：NestJS CLI 配置文件。

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. 项目的配置文件介绍

database.config.ts

import { TypeOrmModuleOptions } from '@nestjs/typeorm';

export const databaseConfig: TypeOrmModuleOptions = {
  type: 'mysql',
  host: 'localhost',
  port: 3306,
  username: 'root',
  password: 'password',
  database: 'nestjs_db',
  entities: [__dirname + '/../**/*.entity{.ts,.js}'],
  synchronize: true,
};

app.config.ts

export const appConfig = {
  port: 3000,
  environment: 'development',
};

配置文件说明：

• database.config.ts：数据库配置文件，定义了数据库连接的详细信息。
• app.config.ts：应用程序配置文件，定义了应用程序的端口和环境。

以上是 NestJS 项目的目录结构、启动文件和配置文件的详细介绍。希望这些内容能帮助你更好地理解和使用 NestJS 项目。

nestjsNestJS MikroORM integration项目地址:https://gitcode.com/gh_mirrors/nes/nestjs