开源项目 fir 使用教程

开源项目 fir 使用教程

1. 项目目录结构及介绍

fir 项目的目录结构如下：

fir/
├── README.md
├── LICENSE
├── package.json
├── src/
│   ├── main.js
│   ├── config/
│   │   ├── default.json
│   │   └── production.json
│   ├── routes/
│   │   └── index.js
│   ├── controllers/
│   │   └── exampleController.js
│   ├── models/
│   │   └── exampleModel.js
│   └── views/
│       └── index.html
└── public/
    └── styles.css

目录结构说明：

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• LICENSE: 项目的开源许可证文件。
• package.json: 项目的依赖管理文件，包含项目的依赖包和脚本命令。
• src/: 项目的源代码目录。
  • main.js: 项目的启动文件。
  • config/: 项目的配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由文件目录，定义了项目的路由规则。
  • controllers/: 控制器文件目录，处理业务逻辑。
  • models/: 模型文件目录，定义数据模型。
  • views/: 视图文件目录，包含前端页面模板。
• public/: 静态资源目录，包含 CSS、JavaScript 等静态文件。

2. 项目启动文件介绍

项目的启动文件是 src/main.js。该文件负责初始化应用程序，加载配置文件，并启动服务器。

主要功能：

• 加载配置文件：根据环境变量加载相应的配置文件（如 default.json 或 production.json）。
• 初始化服务器：创建并启动 HTTP 服务器，监听指定端口。
• 加载路由：加载 routes/index.js 文件，定义应用程序的路由规则。

示例代码：

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

const app = express();

// 加载配置
app.set('config', config);

// 加载路由
routes(app);

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

3. 项目配置文件介绍

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

default.json

默认配置文件，包含开发环境和测试环境的配置。

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

production.json

生产环境配置文件，包含生产环境的配置。

{
  "port": 8080,
  "database": {
    "host": "production_db_host",
    "port": 27017,
    "name": "fir_prod"
  }
}

配置文件加载逻辑

项目启动时，会根据环境变量 NODE_ENV 加载相应的配置文件。如果 NODE_ENV 为 production，则加载 production.json，否则加载 default.json。

const fs = require('fs');
const path = require('path');

const env = process.env.NODE_ENV || 'development';
const configPath = path.join(__dirname, `${env}.json`);

const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));

module.exports = config;

通过以上配置文件，可以灵活地管理不同环境下的应用程序配置。