Truthy CMS（NestJS Headless API）开源项目教程

Truthy CMS（NestJS Headless API）开源项目教程

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

Truthy CMS 是一个基于 NestJS 的 Headless API，用于构建内容管理系统（CMS）。以下是项目的目录结构及各部分的功能介绍：

truthy/
├── config/                                * 包含所有配置文件
│   ├── default.yml                         * 默认配置文件。
│   ├── development.yml                     * 开发环境配置文件。
│   ├── production.yml                      * 生产环境配置文件。
│   └── test.yml                            * 测试环境配置文件。
├── coverage/                               * 运行 `yarn coverage` 命令后的覆盖率报告。
├── dist/                                   * 生产环境优化后的代码，`yarn build` 执行后生成。
├── images/                                 * 存储上传的资料图片的文件夹。此文件夹被 Git 忽略。
├── src/
│   ├── <module>/                           * 存储特定模块的所有文件
│   │   ├── dto/                            * 数据传输对象。
│   │   ├── entity/                         * 模块的模型。
│   │   ├── pipes/                          * 包含 NestJS 模块的验证管道。
│   │   ├── serializer/                     * 包含模型数据的序列化器。
│   │   ├── <module>.controller.ts          * 控制器文件。
│   │   ├── <module>.module.ts              * 模块的根模块文件。
│   │   ├── <module>.service.ts             * 模块的服务文件。
│   │   ├── <module>.service.spec.ts        * 服务的测试文件。
│   │   ├── <module>.repository.ts          * 模块的仓库文件。
│   │   └── <module>.repository.spec.ts     * 仓库的测试文件。
│   ├── common/                             * 通用的帮助函数、DTO、实体、异常、装饰器等。
│   ├── config/                             * 配置变量文件。
│   └── database/                           * 包含迁移和种子文件的数据库文件夹。
├── .gitignore                              * 指定 Git 忽略的文件和目录。
├── .prettierrc                             * Prettier 的配置文件。
├── .eslintrc.js                            * ESLint 的配置文件。
├── Dockerfile                              * Docker 的构建文件。
├── Dockerfile.dev                          * 开发环境的 Docker 构建文件。
├── README.md                               * 项目说明文件。
└── package.json                            * 项目依赖和脚本。

2. 项目的启动文件介绍

项目的启动文件主要包括 package.json 中的脚本，以下是一些常用的启动脚本：

• yarn start:dev: 在开发和监视模式下运行应用程序。
• yarn build: 构建应用程序以供生产环境。
• yarn lint: 检查 src、apps、libs、test 文件夹中的文件并进行格式化。
• yarn format: 使用 prettier 格式化 src 文件夹中的所有文件。

3. 项目的配置文件介绍

配置文件位于 config 目录下，根据不同的环境（开发、生产、测试）有不同的配置文件：

• default.yml: 默认配置文件，提供基本配置。
• development.yml: 开发环境配置文件，包含特定于开发环境的配置。
• production.yml: 生产环境配置文件，包含特定于生产环境的配置。
• test.yml: 测试环境配置文件，包含特定于测试环境的配置。

配置文件使用 YAML 格式，可以通过环境变量来覆盖配置文件中的设置。