TRPC-Playground 项目启动与配置教程

1. 项目目录结构及介绍

trpc-playground 的目录结构如下：

trpc-playground/
├── .gitignore           # 忽略文件列表
├── .vscode/             # VSCode 配置文件夹
├── Dockerfile           # Docker 镜像构建文件
├── README.md            # 项目说明文档
├── db/                  # 数据库相关文件
│   └── schema.sql       # 数据库架构文件
├── packages/            # 项目模块文件夹
│   ├── api/             # API 接口模块
│   │   └── src/         # 源代码文件夹
│   ├── client/          # 客户端模块
│   │   └── src/         # 源代码文件夹
│   ├── server/          # 服务端模块
│   │   └── src/         # 源代码文件夹
│   └── utils/           # 工具模块
│       └── src/         # 源代码文件夹
├── scripts/             # 脚本文件夹
├── src/                 # 主源代码文件夹
│   ├── index.js         # 入口文件
│   └── server.js        # 服务端启动文件
└── yarn.lock            # 依赖锁文件

• .gitignore：指定 Git 忽略的文件和目录。
• .vscode/：Visual Studio Code 的配置文件夹。
• Dockerfile：用于构建 Docker 镜像的文件。
• README.md：项目的说明文档。
• db/：包含数据库相关文件，如数据库架构定义。
• packages/：存放项目模块的文件夹。
  • api/：API 接口模块。
  • client/：客户端模块。
  • server/：服务端模块。
  • utils/：工具模块。
• scripts/：存放各种脚本文件的文件夹。
• src/：主源代码文件夹。
  • index.js：项目入口文件。
  • server.js：服务端启动文件。
• yarn.lock：记录项目依赖的版本信息。

2. 项目的启动文件介绍

项目的启动文件为 src/server.js，其主要职责是启动服务端并监听指定端口。

const app = require('./app'); // 引入应用模块
const PORT = process.env.PORT || 3000; // 端口配置

app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

该文件通过 app.listen 函数启动服务，默认监听 3000 端口。

3. 项目的配置文件介绍

项目的配置通常在环境变量中设置，例如端口配置 PORT 可以在环境变量中指定，如果没有指定，则默认使用 3000。

除此之外，项目的配置可能还会涉及到数据库连接信息、API 密钥等敏感信息。这些信息通常不会直接硬编码在源代码中，而是通过 .env 文件或环境变量来管理。

如果项目使用了 .env 文件，它通常位于项目根目录，并通过 dotenv 库在 server.js 中加载：

require('dotenv').config(); // 加载环境变量
const PORT = process.env.PORT || 3000; // 使用环境变量中的端口配置

在实际项目中，你需要在 .env 文件中设置相应的配置值，例如：

PORT=3000
DB_HOST=localhost
DB_USER=root
DB_PASS=secret

确保 .env 文件不会被提交到版本控制系统中，以保护敏感信息。