UniGoal 项目启动与配置教程

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

UniGoal 项目的目录结构如下所示：

UniGoal/
├── assets/          # 存放静态资源，如图片、CSS 文件等
├── config/          # 配置文件存放目录
├── controllers/     # 业务逻辑处理目录，包含处理请求的控制器
├── middleware/      # 中间件目录，用于处理跨切面逻辑
├── models/          # 数据模型目录，定义了项目中的数据结构
├── public/          # 公共目录，通常包含静态文件和入口文件
├── routes/          # 路由配置目录，定义了 URL 与控制器的映射关系
├── views/           # 视图文件目录，包含 HTML、模板等
├── .env             # 环境变量配置文件
├── app.js           # 项目的主入口文件
├── package.json     # 项目依赖和配置信息
└── README.md        # 项目说明文件

各目录及文件简要说明：

• assets/：存储项目的静态资源文件，如图片、CSS、JavaScript 等。
• config/：存放项目的配置文件，如数据库配置、第三方服务配置等。
• controllers/：包含处理 HTTP 请求的业务逻辑代码。
• middleware/：存放中间件，用于处理如权限验证、日志记录等跨切面逻辑。
• models/：定义项目中的数据模型，通常与数据库表对应。
• public/：通常包含项目的入口文件 index.html，以及可以被直接访问的静态文件。
• routes/：定义项目的路由，将 URL 映射到相应的控制器方法。
• views/：存放 HTML 模板文件，通常用于动态生成页面内容。
• .env：环境变量配置文件，用于配置不同的运行环境。
• app.js：项目的入口文件，初始化并配置 Express 应用。
• package.json：项目的配置文件，定义了项目的依赖、启动脚本等信息。
• README.md：项目的说明文档，通常包含项目介绍、安装指南等。

2. 项目的启动文件介绍

项目的启动文件是 app.js。以下是 app.js 的基本结构：

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

// 引入中间件
app.use(express.json());
app.use(express.urlencoded({ extended: false }));

// 配置静态文件目录
app.use(express.static('public'));

// 引入路由配置
const indexRouter = require('./routes/index');
app.use('/', indexRouter);

// 设置监听端口
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

module.exports = app;

在 app.js 文件中，首先引入了 Express 模块，并创建了一个 Express 应用实例。然后，配置了中间件，如 express.json() 用于解析 JSON 类型的请求体。接下来，配置静态文件目录，使得 public 目录中的文件可以直接通过 URL 访问。之后，引入了路由配置文件，并将它们挂载到相应的路径上。最后，设置应用监听的端口，并启动服务器。

3. 项目的配置文件介绍

项目的配置文件位于 config 目录中。以下是一些常见的配置文件及其作用：

• config.json：基础配置文件，可能包含数据库连接信息、第三方服务 API 密钥等。
• db.config.js：数据库配置文件，定义数据库连接参数。

例如，config.json 的内容可能如下：

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "password",
    "database": "unigoal_db"
  },
  "secret": "supersecretkey"
}

而在 db.config.js 中，可能会使用上述配置信息来创建数据库连接：

const config = require('../config/config.json');

module.exports = {
  mongoURI: `mongodb://${config.database.host}:${config.database.port}/${config.database.database}`,
  secretOrKey: config.secret
};

通过这样的配置文件，可以方便地管理和修改项目配置，同时也便于在不同环境下切换配置。