Thorium Reader 开源项目教程

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

Thorium Reader 项目的目录结构如下：

thorium-reader/
├── assets/
├── build/
├── docs/
├── scripts/
├── src/
│   ├── main/
│   ├── renderer/
│   └── shared/
├── test/
├── .eslintrc.json
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json

目录介绍：

• assets/: 存放项目的静态资源文件，如图片、字体等。
• build/: 存放构建生成的文件，如编译后的代码、打包文件等。
• docs/: 存放项目的文档文件，如用户手册、开发者指南等。
• scripts/: 存放项目的脚本文件，如构建脚本、自动化测试脚本等。
• src/: 存放项目的源代码文件，包括主进程代码、渲染进程代码和共享代码。
  • main/: 存放 Electron 主进程的代码。
  • renderer/: 存放 Electron 渲染进程的代码。
  • shared/: 存放主进程和渲染进程共享的代码。
• test/: 存放项目的测试代码文件。
• .eslintrc.json: ESLint 配置文件，用于代码风格检查。
• .gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
• package.json: 项目的 npm 配置文件，包含项目的依赖、脚本等信息。
• README.md: 项目的说明文档，通常包含项目的简介、安装和使用说明等。
• tsconfig.json: TypeScript 配置文件，用于配置 TypeScript 编译选项。

2. 项目的启动文件介绍

Thorium Reader 项目的启动文件是 src/main/index.ts。这个文件是 Electron 主进程的入口文件，负责启动应用程序的主窗口、管理应用程序的生命周期等。

主要功能：

• 初始化 Electron 应用程序。
• 创建主窗口并加载渲染进程的 HTML 文件。
• 处理应用程序的生命周期事件，如 ready、window-all-closed、before-quit 等。

3. 项目的配置文件介绍

Thorium Reader 项目的主要配置文件包括 package.json 和 tsconfig.json。

package.json

package.json 是 npm 项目的配置文件，包含了项目的元数据、依赖、脚本等信息。

主要字段：

• name: 项目的名称。
• version: 项目的版本号。
• main: 指定 Electron 主进程的入口文件。
• scripts: 定义了项目的脚本命令，如 start、build、test 等。
• dependencies: 项目的生产环境依赖。
• devDependencies: 项目的开发环境依赖。

tsconfig.json

tsconfig.json 是 TypeScript 项目的配置文件，用于配置 TypeScript 编译选项。

主要字段：

• compilerOptions: 编译选项，如 target、module、outDir 等。
• include: 指定需要编译的 TypeScript 文件。
• exclude: 指定不需要编译的 TypeScript 文件。