ACK NestJs Boilerplate 使用教程
1. 项目的目录结构及介绍
ACK NestJs Boilerplate 项目的目录结构如下:
ack-nestjs-boilerplate/
├── src/
│ ├── app.module.ts
│ ├── main.ts
│ ├── modules/
│ │ ├── auth/
│ │ ├── user/
│ │ └── ...
│ ├── shared/
│ │ ├── decorators/
│ │ ├── filters/
│ │ ├── interceptors/
│ │ └── ...
│ └── ...
├── test/
├── docker/
├── .env.example
├── .gitignore
├── .prettierrc
├── commitlintrc
├── docker-compose.yml
├── Dockerfile
├── LICENSE
├── nest-cli.json
├── package.json
├── README.md
├── tsconfig.build.json
└── tsconfig.json
目录结构介绍
src/
: 包含项目的源代码。app.module.ts
: 应用程序的根模块。main.ts
: 应用程序的入口文件。modules/
: 包含各个模块的代码,如auth
和user
。shared/
: 包含共享的装饰器、过滤器、拦截器等。
test/
: 包含测试文件。docker/
: 包含 Docker 相关文件。.env.example
: 环境变量示例文件。.gitignore
: Git 忽略文件。.prettierrc
: Prettier 配置文件。commitlintrc
: Commitlint 配置文件。docker-compose.yml
: Docker Compose 配置文件。Dockerfile
: Docker 配置文件。LICENSE
: 许可证文件。nest-cli.json
: NestJS CLI 配置文件。package.json
: 项目依赖和脚本配置文件。README.md
: 项目说明文档。tsconfig.build.json
: TypeScript 构建配置文件。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.example
.env.example
是环境变量示例文件,包含项目运行所需的环境变量。实际使用时,应复制为 .env
并根据实际情况进行配置。
# 数据库连接字符串
DATABASE_URL=mongodb://localhost:27017/mydatabase
# JWT 密钥
JWT_SECRET=mysecret
# 其他环境变量...
package.json
package.json
包含项目的依赖和脚本配置。以下是部分关键内容:
{
"name": "ack-nestjs-boilerplate",
"version": "1.0.0",
"scripts": {
"start": "nest start",
"build": "nest build",
"test": "jest"
},
"dependencies": {
"@nestjs/common": "^10.0.0",
"@nestjs/core": "^10.0.0",
"mongoose": "^6.0.0",
"dotenv": "^10.0.0",
"passport": "^0.5.0",
"passport-jwt": "^4.0.0"
},
"devDependencies": {
"@nestjs/testing": "^10.0.0",
"jest": "^27.0.