ExpressLRS Configurator 项目教程

1. 项目目录结构及介绍

ExpressLRS Configurator 是一个跨平台的构建和配置工具，用于 ExpressLRS 开源 RC 链路。项目的目录结构如下：

ExpressLRS-Configurator/
├── assets/
├── dependencies/
├── devices/
├── docs/
│   └── readme/
├── release/
│   └── app/
├── src/
├── .editorconfig
├── .eslintignore
├── .eslintrc.js
├── .gitattributes
├── .gitignore
├── .nvmrc
├── LICENSE
├── README.md
├── codegen.yml
├── crowdin.yml
├── graphql.schema.json
├── package.json
├── tsconfig.json
└── yarn.lock

目录结构介绍

• assets/: 存放项目相关的静态资源文件。
• dependencies/: 存放项目的依赖文件。
• devices/: 存放与设备相关的配置和脚本。
• docs/: 存放项目的文档，包括 readme 文件。
• release/app/: 存放项目的发布版本文件。
• src/: 存放项目的源代码。
• .editorconfig: 编辑器配置文件。
• .eslintignore: ESLint 忽略文件配置。
• .eslintrc.js: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .nvmrc: Node.js 版本配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• codegen.yml: 代码生成配置文件。
• crowdin.yml: Crowdin 本地化配置文件。
• graphql.schema.json: GraphQL 模式文件。
• package.json: Node.js 项目配置文件。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目启动文件介绍

项目的启动文件主要位于 src/ 目录下。以下是主要的启动文件及其功能介绍：

• src/main.ts: 主进程入口文件，负责启动和管理 Electron 应用的主进程。
• src/renderer.ts: 渲染进程入口文件，负责启动和管理 Electron 应用的渲染进程。
• src/configurator.ts: 配置管理文件，负责处理配置相关的逻辑。
• src/api-server.ts: API 服务器文件，负责处理与硬件设备的通信。

启动流程

1. main.ts: 启动主进程，初始化 Electron 应用。
2. renderer.ts: 启动渲染进程，加载用户界面。
3. configurator.ts: 初始化配置管理器，加载用户配置。
4. api-server.ts: 启动 API 服务器，处理与硬件设备的通信。

3. 项目的配置文件介绍

项目的配置文件主要用于定义项目的运行环境和构建选项。以下是主要的配置文件及其功能介绍：

• .editorconfig: 定义编辑器的配置，确保团队成员使用一致的编码风格。
• .eslintrc.js: 定义 ESLint 的规则，用于代码质量检查。
• .gitignore: 定义 Git 忽略的文件和目录，避免不必要的文件被提交到版本库。
• .nvmrc: 定义 Node.js 的版本，确保项目在一致的环境中运行。
• codegen.yml: 定义代码生成的配置，用于自动生成 TypeScript 类型和 GraphQL 查询。
• crowdin.yml: 定义 Crowdin 本地化工具的配置，用于管理项目的多语言支持。
• graphql.schema.json: 定义 GraphQL 的模式，用于前后端数据交互。
• package.json: 定义 Node.js 项目的依赖和脚本，包括启动、构建和测试等命令。
• tsconfig.json: 定义 TypeScript 的编译选项，确保代码编译的一致性。

配置文件的使用

• .editorconfig: 在编辑器中安装相应的插件后，自动应用配置。
• .eslintrc.js: 在项目中运行 eslint 命令时，自动应用配置。
• .gitignore: 在 Git 提交时，自动忽略配置中定义的文件和目录。
• .nvmrc: 在项目中运行 nvm use 命令时，自动切换到配置的 Node.js 版本。
• codegen.yml: 在项目中运行 yarn run gql-codegen 命令时，自动生成代码。
• crowdin.yml: 在 Crowdin 平台上配置项目时，自动应用配置。
• graphql.schema.json: 在前后端开发时，作为数据交互的规范。
• package.json: 在项目中运行 yarn install 命令时，自动安装依赖；运行 yarn start 命令时，自动启动项目。
• tsconfig.json: 在项目中运行 tsc 命令时，自动应用配置。

通过以上配置文件，ExpressLRS Configurator 项目能够确保代码质量、开发环境和构建流程的一致性，从而提高开发效率和代码的可维护性。