项目教程：Airi 的安装与使用

项目教程：Airi 的安装与使用

airi アイリ VTuber. LLM powered Live2D/VRM living character, near by you. 💖 项目地址: https://gitcode.com/gh_mirrors/ai/airi

1. 项目目录结构及介绍

Airi 项目采用模块化的目录结构，使得项目的管理和维护更加清晰。以下是项目的目录结构及各个部分的简要介绍：

airi/
├── .github/                # GitHub 相关配置
├── .vscode/                # VSCode 编辑器配置
├── apps/                   # 应用程序目录
├── docs/                   # 文档目录
├── packages/               # 项目依赖的包
├── scripts/                # 脚本目录
├── services/               # 服务相关代码
├── .editorconfig            # 编辑器配置文件
├── .gitignore              # Git 忽略文件
├── .npmrc                  # npm 配置文件
├── CONTRIBUTING.md         # 贡献指南
├── LICENSE                 # 开源协议
├── README.md               # 项目说明文件
├── README.zh-CN.md         # 项目说明文件（中文）
├── bump.config.ts          # 版本更新配置
├── changelogithub.config.ts # GitHub 日志配置
├── cspell.config.yaml       # 代码拼写检查配置
├── eslint.config.js        # ESLint 配置
├── package.json            # 项目依赖和配置
├── pnpm-lock.yaml           # pnpm 锁文件
├── pnpm-workspace.yaml      # pnpm 工作区配置
├── tsconfig.json           # TypeScript 配置
├── uno.config.ts           # UnoCSS 配置
└── vitest.workspace.ts     # Vitest 测试配置

2. 项目的启动文件介绍

项目的启动文件位于 scripts 目录中，主要包括以下文件：

• pnpm dev: 项目开发环境启动脚本，用于启动本地开发环境。
• pnpm i: 项目依赖安装脚本，用于安装项目依赖。

在开发环境中，你可以通过运行以下命令启动项目：

pnpm dev

这将会启动本地开发环境，并监听文件变化以实时更新项目。

3. 项目的配置文件介绍

项目的配置文件主要包括以下文件：

• .editorconfig: 编辑器配置文件，用于统一不同开发者的代码风格。
• .gitignore: Git 忽略文件，用于指定不需要提交到版本库的文件和目录。
• .npmrc: npm 配置文件，用于设置项目的 npm 配置。
• tsconfig.json: TypeScript 配置文件，用于配置 TypeScript 编译选项。
• uno.config.ts: UnoCSS 配置文件，用于配置 UnoCSS 相关选项。

确保在使用项目之前，你已经正确配置了这些文件，以保证项目的正常运行和开发体验。

airi アイリ VTuber. LLM powered Live2D/VRM living character, near by you. 💖 项目地址: https://gitcode.com/gh_mirrors/ai/airi