eSearch 安装与使用教程

1. 项目目录结构及介绍

以下为 eSearch 项目的基本目录结构：

eSearch/
├── src/                  # 主要代码源文件
│   ├── main.js           # 应用主入口文件
│   ├── renderer.ts       # 渲染进程文件
│   └── ...
├── public/               # 公共资源文件
│   ├── index.html        # 应用的HTML模板
│   └── ...
├── tsconfig.web.json     # TypeScript编译配置
├── package.json          # 项目依赖和脚本配置
└── ...                   # 其他辅助文件

• src/: 包含应用的核心代码，main.js管理Electron主进程，renderer.ts处理浏览器渲染。
• public/: 存放静态资源，如HTML模板和图标等。
• tsconfig.web.json: TypeScript的Web相关编译配置。

2. 项目启动文件介绍

src/main.js

这是Electron应用的主进程文件，负责初始化应用程序，创建浏览器窗口，管理系统级事件以及与渲染进程通信。

主要任务包括：

• 初始化Electron应用并监听应用生命周期事件。
• 创建主窗口，设置窗口大小、位置等属性。
• 注册菜单项和快捷键。
• 处理与渲染进程的通信。

src/renderer.ts

渲染进程文件，主要用于界面展示和用户交互。在这里，你可以找到处理组件加载、事件监听、数据处理等功能的代码。

3. 项目配置文件介绍

eSearch 使用 package.json 文件来存储项目配置和依赖关系。关键配置包括：

{
  "name": "eSearch",
  "version": "x.x.x",
  "description": "项目描述",
  "main": "src/main.js",      // Electron应用的入口文件
  "scripts": {
    "start": "electron .",   // 启动应用的命令
    "build": "tsc"           // 编译TypeScript源码
  },
  "dependencies": { ... },  // 项目运行依赖的npm包
  "devDependencies": { ... } // 开发阶段依赖的npm包
}

• "main": 指定Electron应用的主进程入口文件。
• "scripts": 提供了一些常用的开发脚本，如"start"用于运行应用，"build"用于编译TypeScript代码。
• "dependencies" 和 "devDependencies": 分别记录项目所需的生产环境和开发环境的依赖库。

要启动项目，只需在终端执行 npm start，这将会调用package.json中定义的start脚本，启动eSearch应用程序。

请注意，项目可能还涉及到其他的配置文件，例如.env用于环境变量，具体取决于项目需求。如需了解更多细节，建议参考项目仓库内的文档或直接查阅源代码。