Yazi 项目安装与使用教程

1. 项目目录结构及介绍

Yazi 项目目录结构如下：

ouch.yazi/
├── .gitignore          # Git 忽略文件列表
├── .travis.yml         # Travis CI 配置文件
├── CHANGELOG.md        # 项目更新日志
├── LICENSE             # 项目许可证文件
├── README.md           # 项目说明文件
├──circle.yml           # CircleCI 配置文件
├── config/             # 配置文件目录
│   ├── default.json    # 默认配置文件
│   └── production.json # 生产环境配置文件
├── dist/               # 构建输出目录
├── docs/               # 文档目录
├── node_modules/       # 项目依赖的 Node.js 模块
├── package.json        # 项目元数据文件
├── package-lock.json   # 项目依赖锁定文件
├── src/                # 源代码目录
│   ├── index.js        # 入口文件
│   ├── server.js       # 服务器逻辑
│   └── utils/          # 工具类目录
│       └── ...         # 具体工具类文件
└── test/               # 测试代码目录

2. 项目的启动文件介绍

项目的启动文件为 src/index.js。以下是启动文件的简要介绍：

// 引入必要的模块
const http = require('http');
const app = require('./server');

// 设置服务器端口
const PORT = process.env.PORT || 3000;

// 创建 HTTP 服务器并监听指定端口
http.createServer(app).listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

该文件通过引入 Node.js 的 http 模块和项目中的 server.js 文件，创建并启动一个 HTTP 服务器。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包括以下两个文件：

• default.json：默认配置文件，包含项目的基本配置。
• production.json：生产环境配置文件，包含项目在生产环境下的特定配置。

以下是一个示例的 default.json 配置文件内容：

{
  "port": 3000,
  "db": {
    "host": "localhost",
    "port": 27017,
    "name": "yazi"
  }
}

该配置文件定义了服务器的端口号和数据库的连接信息。实际使用时，您可能需要根据实际情况调整配置项。