NestJS Prisma 项目教程
1. 项目的目录结构及介绍
NestJS Prisma 项目的目录结构通常包含以下几个主要部分:
nestjs-prisma/
├── src/
│ ├── app.module.ts
│ ├── main.ts
│ ├── prisma/
│ │ ├── prisma.service.ts
│ │ └── schema.prisma
│ └── ...
├── test/
├── .env
├── .gitignore
├── package.json
├── tsconfig.json
└── ...
目录结构介绍
- src/: 包含项目的源代码。
- app.module.ts: 应用程序的根模块。
- main.ts: 应用程序的入口文件。
- prisma/: Prisma 相关的文件。
- prisma.service.ts: Prisma 服务的实现。
- schema.prisma: Prisma 的配置文件,定义数据模型和数据库连接。
- test/: 包含项目的测试代码。
- .env: 环境变量配置文件。
- .gitignore: Git 忽略文件配置。
- package.json: 项目依赖和脚本配置。
- tsconfig.json: TypeScript 编译配置。
2. 项目的启动文件介绍
main.ts
main.ts
是 NestJS 应用程序的入口文件,负责启动应用程序。以下是一个典型的 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();
启动文件介绍
- NestFactory.create(AppModule): 创建 NestJS 应用程序实例。
- app.listen(3000): 监听端口 3000,启动应用程序。
3. 项目的配置文件介绍
.env
.env
文件用于存储环境变量,例如数据库连接字符串、密钥等。以下是一个典型的 .env
文件内容:
DATABASE_URL=postgresql://user:password@localhost:5432/mydatabase
schema.prisma
schema.prisma
文件是 Prisma 的配置文件,定义数据模型和数据库连接。以下是一个典型的 schema.prisma
文件内容:
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
generator client {
provider = "prisma-client-js"
}
model User {
id Int @id @default(autoincrement())
name String
email String @unique
}
配置文件介绍
- datasource db: 定义数据库连接,使用环境变量
DATABASE_URL
。 - generator client: 定义 Prisma 客户端生成器。
- model User: 定义数据模型,例如
User
模型。
通过以上内容,您可以了解 NestJS Prisma 项目的基本结构、启动文件和配置文件。希望这份教程对您有所帮助。