Zodex 项目启动与配置教程

1. 项目目录结构及介绍

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

zodex/
├── .gitignore
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   └── config.js
│   ├── models/
│   │   └── user.js
│   ├── routes/
│   │   └── userRoutes.js
│   ├── controllers/
│   │   └── userController.js
│   └── utils/
│       └── logger.js
├── test/
└── yarn.lock

• .gitignore：用于指定哪些文件和目录应该被 Git 忽略。
• README.md：项目说明文件，通常包含项目介绍、安装指南、使用说明等。
• package.json：项目依赖和脚本配置文件。
• src/：源代码目录。
  • index.js：项目入口文件。
  • config/：配置文件目录。
    • config.js：项目配置文件，包含数据库连接、端口号等配置。
  • models/：数据模型目录。
    • user.js：用户模型文件。
  • routes/：路由文件目录。
    • userRoutes.js：用户相关路由设置。
  • controllers/：控制器目录。
    • userController.js：用户相关逻辑控制。
  • utils/：工具类目录。
    • logger.js：日志记录工具。
• test/：测试代码目录。
• yarn.lock：依赖锁定文件，确保项目依赖的一致性。

2. 项目的启动文件介绍

项目启动文件为 src/index.js。以下是启动文件的示例代码：

const app = require('./app'); // 引入应用对象
const config = require('./config/config'); // 引入配置对象

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

该文件通过 require 引入了应用对象和配置对象，然后调用 listen 方法启动服务器，监听配置文件中指定的端口。

3. 项目的配置文件介绍

项目配置文件为 src/config/config.js。以下是配置文件的示例内容：

module.exports = {
  port: 3000, // 服务端口号
  db: {
    host: 'localhost', // 数据库地址
    user: 'root', // 数据库用户
    password: 'password', // 数据库密码
    database: 'zodex_db' // 数据库名称
  }
};

配置文件包含了服务器的端口号和数据库连接所需的信息。通过导出这些配置，其他模块可以方便地获取和使用这些配置信息。