Aragon Nest 项目教程

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

nest/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── modules/
│   │   ├── module1/
│   │   │   ├── index.js
│   │   │   ├── routes.js
│   │   ├── module2/
│   │   │   ├── index.js
│   │   │   ├── routes.js
├── tests/
│   ├── module1.test.js
│   ├── module2.test.js

目录结构介绍

• README.md: 项目说明文件。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • modules/: 模块目录，包含各个功能模块。
    • module1/: 模块1目录。
      • index.js: 模块1入口文件。
      • routes.js: 模块1路由文件。
    • module2/: 模块2目录。
      • index.js: 模块2入口文件。
      • routes.js: 模块2路由文件。
• tests/: 测试文件目录。
  • module1.test.js: 模块1的测试文件。
  • module2.test.js: 模块2的测试文件。

2. 项目的启动文件介绍

src/index.js

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

app.get('/', (req, res) => {
  res.send('Hello World!');
});

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

启动文件介绍

• 引入 express 模块创建应用实例。
• 加载配置文件 config。
• 定义根路由 /，返回 "Hello World!"。
• 监听配置文件中定义的端口，默认端口为 3000。

3. 项目的配置文件介绍

src/config/default.json

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

src/config/production.json

{
  "port": 8080,
  "database": {
    "host": "production-db-host",
    "port": 27017,
    "name": "nest-production"
  }
}

配置文件介绍

• default.json: 默认配置文件，包含开发环境的端口和数据库配置。
• production.json: 生产环境配置文件，包含生产环境的端口和数据库配置。

通过这些配置文件，可以根据不同的环境加载不同的配置，实现环境变量的管理。