sf-nest-admin 项目教程

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

sf-nest-admin 是一个基于 NestJS + TypeScript + TypeORM + Redis + MySql + Vue2 + Element-UI 的前后端分离的权限管理系统。以下是项目的目录结构及其简单介绍：

sf-nest-admin/
├── .github/                    # GitHub 工作流和其他GitHub相关配置
├── docker/                     # Docker相关配置文件
├── docs/                       # 项目文档
├── public/                     # 公共静态文件
├── sql/                        # SQL文件
├── src/                        # 源代码目录
│   ├── common/                 # 公共模块
│   ├── config/                 # 配置模块
│   ├── controllers/            # 控制器模块
│   ├── entities/               # 实体模块
│   ├── filters/                # 过滤器模块
│   ├── guards/                 # 守卫模块
│   ├── interceptors/           # 拦截器模块
│   ├── middlewares/            # 中间件模块
│   ├── modules/                # 模块目录
│   ├── pipes/                  # 管道模块
│   ├── providers/              # 提供者模块
│   ├── routes/                 # 路由模块
│   ├── services/               # 服务模块
│   └── app.controller.ts       # 根控制器
├── test/                       # 测试目录
├── .dockerignore               # Docker 忽略文件
├── .eslintrc.js                # ESLint 配置文件
├── .gitignore                  # Git 忽略文件
├── .prettierrc                 # Prettier 配置文件
├── Dockerfile                  # Docker 构建文件
├── LICENSE                     # 项目许可证
├── README.md                   # 项目说明文件
├── nest-cli.json               # Nest CLI 配置文件
├── package.json                # Node.js 项目配置文件
└── tsconfig.json               # TypeScript 配置文件

2. 项目的启动文件介绍

项目的启动主要是通过 src/main.ts 文件来完成的。以下是 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 文件创建了一个 Nest 应用实例，并监听在3000端口。

3. 项目的配置文件介绍

项目的配置主要通过 src/config 目录下的文件进行管理。以下是配置文件的基本内容：

• app.config.ts：包含应用级配置，如数据库连接信息、Redis配置等。
• app.module.ts：定义了应用模块及其相关的依赖注入。
• auth.config.ts：包含认证相关的配置，如JWT密钥等。

配置文件使用模块化的方式进行组织，使得配置管理更加清晰和易于维护。在配置文件中，通常会使用环境变量来保护敏感信息，并允许在不同的环境中使用不同的配置。