开源项目 OTS 使用教程

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

OTS 项目的目录结构如下：

ots/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── api.js
│   ├── models/
│   │   ├── user.js
│   ├── controllers/
│   │   ├── userController.js
│   ├── utils/
│   │   ├── logger.js

目录结构介绍

• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由文件目录。
    • api.js: API 路由文件。
  • models/: 数据模型文件目录。
    • user.js: 用户模型文件。
  • controllers/: 控制器文件目录。
    • userController.js: 用户控制器文件。
  • utils/: 工具函数文件目录。
    • logger.js: 日志工具文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。该文件主要负责以下内容：

• 导入必要的模块和配置文件。
• 初始化 Express 应用。
• 配置中间件。
• 设置路由。
• 启动服务器。

以下是 src/index.js 的简化代码示例：

const express = require('express');
const config = require('config');
const logger = require('./utils/logger');
const apiRoutes = require('./routes/api');

const app = express();
const port = config.get('port');

app.use(express.json());
app.use('/api', apiRoutes);

app.listen(port, () => {
  logger.info(`Server is running on port ${port}`);
});

3. 项目的配置文件介绍

项目的配置文件位于 src/config/ 目录下，主要包括 default.json 和 production.json。

default.json

默认配置文件，包含开发环境和测试环境的配置。

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "ots_dev"
  }
}

production.json

生产环境配置文件，包含生产环境的配置。

{
  "port": 8080,
  "database": {
    "host": "prod-db-host",
    "port": 27017,
    "name": "ots_prod"
  }
}

配置文件通过 config 模块加载，可以根据环境变量选择不同的配置文件。例如，在生产环境中，可以通过设置 NODE_ENV=production 来加载 production.json 配置文件。