Phoenix 开源项目使用教程

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

Phoenix 项目的目录结构如下：

phoenix/
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── utils/
│   │   ├── logger.js
│   ├── routes/
│   │   ├── api.js
├── package.json
├── README.md

目录结构介绍

• src/：项目的源代码目录。
  • index.js：项目的入口文件。
  • config/：配置文件目录。
    • default.json：默认配置文件。
    • production.json：生产环境配置文件。
  • utils/：工具函数目录。
    • logger.js：日志工具函数。
  • routes/：路由文件目录。
    • api.js：API 路由文件。
• package.json：项目的依赖管理文件。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。该文件主要负责初始化应用、加载配置、设置路由等。

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

const app = express();
const port = config.get('port');

app.use('/api', apiRoutes);

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

启动文件介绍

• 引入 express 框架。
• 加载配置文件。
• 引入日志工具函数。
• 设置 API 路由。
• 启动服务器并监听指定端口。

3. 项目的配置文件介绍

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

default.json

{
  "port": 3000,
  "logLevel": "debug"
}

production.json

{
  "port": 8080,
  "logLevel": "info"
}

配置文件介绍

• default.json：默认配置文件，包含开发环境的配置信息。
  • port：服务器监听的端口。
  • logLevel：日志级别。
• production.json：生产环境配置文件，包含生产环境的配置信息。
  • port：服务器监听的端口。
  • logLevel：日志级别。

通过这些配置文件，可以灵活地调整不同环境下的应用配置。