Evalite 项目使用教程

1. 项目目录结构及介绍

Evalite 项目的主要目录结构如下：

evalite/
├── .github/             # GitHub 工作流文件
├── .husky/              # Git hooks 配置
├── apps/                # 应用程序目录
├── packages/            # 包目录，包含 evalite 和 evalite-core 等相关包
├── .vscode/             # VSCode 配置文件
├── .gitignore           # Git 忽略文件
├── LICENSE              # MIT 许可证文件
├── package.json         # 项目元数据及依赖
├── pnpm-lock.yaml       # pnpm 锁文件
├── pnpm-workspace.yaml  # pnpm 工作空间配置
├── readme.md            # 项目说明文件
└── turbo.json           # 项目配置文件

详细介绍：

• .github/: 包含项目的 GitHub 工作流文件，用于自动化项目管理任务，如代码审查、测试等。
• .husky/: 配置 Git hooks，用于在提交代码前执行一些任务，如代码格式化。
• apps/: 存放项目中的应用程序。
• packages/: 包含项目的主要包，如 evalite 和 evalite-core。
• .vscode/: VSCode 配置文件，用于设置开发环境的配置。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目使用的 MIT 许可证。
• package.json: 包含项目的元数据、依赖项和脚本。
• pnpm-lock.yaml: pnpm 的锁文件，用于保证不同环境下的依赖安装一致。
• pnpm-workspace.yaml: pnpm 工作空间配置，用于管理多个包的依赖和脚本。
• readme.md: 项目说明文件，介绍了项目的用途和如何使用。
• turbo.json: 项目配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 packages/example 目录中。主要启动文件如下：

• pnpm run dev: 用于启动开发环境，执行以下任务：
  • 运行 TypeScript 类型检查器。
  • 运行一些测试。
  • 启动 UI 开发服务器。
  • 监听示例目录中的文件更改。

3. 项目的配置文件介绍

项目的主要配置文件如下：

• .gitignore: 用于指定 Git 忽略的文件和目录，例如 node_modules、.env 等目录和文件。
• package.json: 包含项目的元数据、依赖项和脚本。其中脚本包括以下常用命令：
  • pnpm run dev: 启动开发环境。
  • pnpm build: 构建项目。
  • pnpm test: 运行测试。
• pnpm-workspace.yaml: 配置 pnpm 工作空间，用于管理多个包的依赖和脚本。
• turbo.json: 项目配置文件，用于配置项目的各种设置。

在开始使用本项目之前，请确保已经安装了 Node.js 和 pnpm。然后，在项目根目录下运行以下命令安装依赖：

pnpm install

随后，您可以运行以下命令启动开发环境：

pnpm run dev

这将启动项目的开发服务器，并开始监听文件更改。