Lector PDF阅读器项目教程

Lector PDF阅读器项目教程

1. 项目目录结构及介绍

Lector项目是一个基于Electron和PDF.js构建的简单PDF阅读器。以下是项目的目录结构及其组件的简要介绍：

lector/
├── docs/                   # 项目文档存放目录
├── src/                    # 源代码目录
│   ├── main/               # 主进程文件
│   │   ├── index.js        # 主进程入口文件
│   │   └── ...
│   ├── renderer/           # 渲染进程文件
│   │   ├── index.html      # 渲染进程的主HTML文件
│   │   └── ...
│   └── ...
├── .gitignore              # Git忽略文件列表
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── package-lock.json       # 包依赖锁定文件
└── package.json            # 项目包配置文件

• docs/：存放项目文档的目录。
• src/：存放项目源代码的目录，分为main/和renderer/两个子目录。
  • main/：存放主进程的JavaScript文件，index.js是主进程的入口文件。
  • renderer/：存放渲染进程的HTML和JavaScript文件，index.html是渲染进程的主页面。
• .gitignore：定义了Git在提交时应该忽略的文件和目录。
• LICENSE：项目的许可证文件，本项目采用MIT许可证。
• README.md：项目的说明文件，包含了项目的基本信息和如何使用。
• package-lock.json：记录了项目依赖的精确版本，用于确保在不同环境中安装依赖时的一致性。
• package.json：项目的包配置文件，定义了项目的依赖、脚本和其他元数据。

2. 项目的启动文件介绍

项目的启动主要通过package.json中的scripts字段定义的脚本进行。以下是主要的启动脚本：

"scripts": {
  "start": "electron .",
  "dist": "electron-builder --dir"
}

• start：启动脚本，使用Electron运行当前目录（.）作为应用。这个脚本将启动主进程，并加载src/main/index.js文件。
• dist：构建脚本，使用Electron Builder将应用打包成发行版本。

在终端中运行以下命令可以启动项目：

npm start

3. 项目的配置文件介绍

本项目的主要配置文件是package.json。以下是一些重要的配置项：

{
  "name": "lector",
  "version": "1.1.0",
  "description": "A simple PDF Reader built using Electron and PDF.js",
  "main": "src/main/index.js",
  "scripts": {
    "start": "electron .",
    "dist": "electron-builder --dir"
  },
  "dependencies": {
    "electron": "^1.4.13",
    "electron-builder": "^20.38.5",
    "pdfjs-dist": "^2.10.374"
  },
  "devDependencies": {
    "electron-prebuilt-recipe": "^1.0.0"
  }
}

• name：项目的名称。
• version：项目的版本号。
• description：项目的描述。
• main：指定了应用的入口文件，这里是src/main/index.js。
• scripts：定义了项目的脚本命令，如启动和构建脚本。
• dependencies：项目依赖的库，包括Electron、Electron Builder和PDF.js。
• devDependencies：开发环境依赖的库。

通过修改package.json文件，可以调整项目的配置，例如更改项目名称、版本号或添加新的依赖项。