开源项目 Preset 使用教程

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

preset/
├── README.md
├── index.js
├── package.json
├── config/
│   ├── default.json
│   └── production.json
└── src/
    ├── utils/
    │   └── helper.js
    └── main.js

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• index.js: 项目的入口文件，负责启动应用。
• package.json: 项目的依赖管理文件，包含项目的依赖包和脚本命令。
• config/: 配置文件目录，包含默认配置和生产环境配置。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
• src/: 源代码目录，包含项目的核心代码。
  • utils/: 工具函数目录，包含辅助函数。
    • helper.js: 辅助函数文件。
  • main.js: 主逻辑文件。

2. 项目的启动文件介绍

项目的启动文件是 index.js，该文件负责初始化应用并启动服务器。以下是 index.js 的基本内容：

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

// 加载配置
const port = config.get('port');

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

• 引入依赖: 引入了 express 和 config 模块。
• 加载配置: 从配置文件中获取端口号。
• 启动服务器: 使用 express 启动服务器，并在指定端口监听。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包含 default.json 和 production.json 两个文件。

default.json

默认配置文件，包含项目的默认设置：

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

• port: 服务器监听的端口号。
• database: 数据库配置，包含主机、端口和数据库名。

production.json

生产环境配置文件，可以覆盖默认配置：

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

• port: 生产环境服务器监听的端口号。
• database: 生产环境数据库配置，包含主机、端口和数据库名。

通过这些配置文件，可以灵活地管理不同环境下的项目设置。