清洁代码 TypeScript 项目启动与配置教程

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

清洁代码 TypeScript 项目采用模块化的目录结构，以保持代码的整洁和可维护性。以下是项目的目录结构及简要介绍：

clean-code-typescript/
├── src/                      # 源代码目录
│   ├── app/                  # 应用程序目录
│   │   ├── controllers/      # 控制器目录
│   │   ├── models/           # 模型目录
│   │   ├── routes/           # 路由目录
│   │   └── services/         # 服务目录
│   ├── config/               # 配置文件目录
│   ├── middlewares/          # 中间件目录
│   └── utils/                # 工具类目录
├── test/                     # 测试目录
│   └── ...                   # 测试文件
├── .env                      # 环境变量配置文件
├── package.json              # 项目依赖及配置文件
├── tsconfig.json             # TypeScript 配置文件
└── README.md                 # 项目说明文件

2. 项目的启动文件介绍

项目的启动文件位于 src/app 目录下，名为 index.ts。以下是 index.ts 文件的内容：

import express from 'express';
import { json, urlencoded } from 'body-parser';
import { routes } from './routes';

const app = express();
const port = process.env.PORT || 3000;

app.use(json());
app.use(urlencoded({ extended: true }));

app.use('/', routes);

app.listen(port, () => {
  console.log(`Server is running at http://localhost:${port}`);
});

index.ts 文件是项目的入口文件，主要负责以下功能：

• 导入必要的模块（如 express、body-parser 和项目路由 routes）。
• 创建一个 express 应用实例。
• 使用中间件处理请求体（JSON 格式和 URL 编码格式）。
• 将路由挂载到应用实例上。
• 启动服务器，并监听指定端口。

3. 项目的配置文件介绍

项目的配置文件位于 src/config 目录下，名为 config.ts。以下是 config.ts 文件的内容：

export default {
  port: process.env.PORT || 3000,
  // 其他配置项...
};

config.ts 文件用于存储项目级别的配置，如服务器端口等。通过 process.env.PORT 获取环境变量中的端口配置，如果没有则默认使用 3000。开发者可以根据需要在此文件中添加更多配置项。