Triplex 项目使用教程

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

Triplex 项目的目录结构如下：

triplex/
├── config/
│   ├── default.json
│   ├── development.json
│   ├── production.json
│   └── test.json
├── src/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── services/
│   └── index.js
├── test/
├── .env
├── .gitignore
├── package.json
└── README.md

目录结构介绍

• config/: 包含项目的配置文件，如 default.json、development.json、production.json 和 test.json。
• src/: 项目的源代码目录，包含控制器、模型、路由和服务等。
  • controllers/: 存放控制器文件。
  • models/: 存放数据模型文件。
  • routes/: 存放路由定义文件。
  • services/: 存放服务逻辑文件。
  • index.js: 项目的入口文件。
• test/: 存放测试文件。
• .env: 环境变量配置文件。
• .gitignore: Git 忽略文件配置。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。这个文件是整个应用程序的入口点，负责初始化服务器和加载其他模块。

src/index.js 文件内容示例

const express = require('express');
const app = express();
const config = require('config');

// 加载路由
const routes = require('./routes');
app.use('/', routes);

// 启动服务器
const port = config.get('port');
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

启动文件功能介绍

• 引入 express 模块并创建应用实例。
• 加载配置文件并获取端口号。
• 加载路由模块并应用到应用实例。
• 启动服务器并监听指定端口。

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，包括 default.json、development.json、production.json 和 test.json。

config/default.json 文件内容示例

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 5432,
    "name": "triplex"
  }
}

配置文件功能介绍

• default.json: 默认配置文件，包含通用的配置项。
• development.json: 开发环境配置文件，会覆盖 default.json 中的相应配置。
• production.json: 生产环境配置文件，会覆盖 default.json 中的相应配置。
• test.json: 测试环境配置文件，会覆盖 default.json 中的相应配置。

这些配置文件使用 config 模块进行加载和管理，可以根据不同的运行环境加载相应的配置。