开源项目 `env2` 使用教程

开源项目 env2 使用教程

env2:computer: Simple environment variable (from config file) loader for your node.js app项目地址:https://gitcode.com/gh_mirrors/en/env2

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

env2/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   └── utils/
│       ├── logger.js
│       ├── validator.js
├── test/
│   ├── index.test.js
│   ├── config.test.js
└── .env

• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • utils/: 工具函数目录。
    • logger.js: 日志工具。
    • validator.js: 数据验证工具。
• test/: 测试文件目录。
  • index.test.js: 入口文件测试。
  • config.test.js: 配置文件测试。
• .env: 环境变量配置文件。

2. 项目的启动文件介绍

src/index.js 是项目的启动文件，负责初始化应用和启动服务器。以下是该文件的主要内容：

const express = require('express');
const config = require('./config');
const logger = require('./utils/logger');

const app = express();
const port = process.env.PORT || 3000;

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

app.listen(port, () => {
  logger.info(`Server is running on port ${port}`);
});

• 引入依赖: 引入了 express、config 和 logger 模块。
• 创建应用实例: 使用 express() 创建应用实例 app。
• 定义路由: 定义了一个简单的路由 /，返回 "Hello World!"。
• 启动服务器: 使用 app.listen 启动服务器，监听端口 port。

3. 项目的配置文件介绍

src/config/ 目录下包含项目的配置文件，主要有 default.json 和 production.json。

default.json

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

• server: 服务器配置，包括端口。
• database: 数据库配置，包括主机、端口和数据库名。

production.json

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

• server: 生产环境服务器配置，包括端口。
• database: 生产环境数据库配置，包括主机、端口和数据库名。

这些配置文件通过 config 模块加载，根据环境变量选择相应的配置文件。

env2:computer: Simple environment variable (from config file) loader for your node.js app项目地址:https://gitcode.com/gh_mirrors/en/env2