AUProximity 项目使用教程

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

AUProximity 是一个开源的接近度语音聊天平台，主要针对 Among Us 游戏设计。以下是项目的目录结构及各部分的作用：

• .github/：包含 GitHub 工作流的配置文件。
• auproximity-webui/：网页用户界面目录，包含网页端的代码。
  • src/：源代码目录，包含网页端的 JavaScript、CSS 和 HTML 文件。
• auproximity/：服务器端代码目录。
• .dockerignore：Docker 构建时需要忽略的文件列表。
• .gitignore：Git 忽略的文件列表。
• .gitmodules：包含子模块信息的文件。
• CODE_OF_CONDUCT.md：项目行为准则。
• Dockerfile：用于构建 Docker 容器的文件。
• LICENSE：项目使用的许可证文件。
• Procfile：Heroku 等平台部署时使用的进程文件。
• README.md：项目介绍和说明文件。
• app.json：应用配置文件。
• package.json：Node.js 项目配置文件，包含项目依赖和脚本。
• tsconfig.json：TypeScript 配置文件。
• yarn.lock：Yarn 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动主要依赖于 package.json 中的脚本。以下是主要的启动脚本：

• yarn install：安装项目依赖。
• yarn serve：在 auproximity 目录下启动服务器。
• yarn serve：在 auproximity-webui 目录下启动网页用户界面。

在开发模式下，服务器默认监听 8079 端口，网页用户界面默认监听 8080 端口。

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• package.json：此文件中的 scripts 字段定义了各种操作脚本的命令，例如启动服务器和网页界面。
• .env（如果存在）：环境变量配置文件，用于存储敏感配置信息，如数据库连接字符串等。
• config.js 或 config.ts（如果存在）：项目配置文件，用于定义和调整项目配置，如服务器端口、数据库配置等。

请根据项目的具体需求和部署环境，适当调整这些配置文件中的内容，以确保项目能够正确运行。