Deadbolt 项目使用教程

1. 项目目录结构及介绍

Deadbolt 项目的主要目录结构如下：

deadbolt/
├── app/                        # 应用程序主目录
├── assets/                     # 静态资源目录
├── docs/                       # 文档目录
├── img/                        # 图片资源目录
├── release/                    # 发布版本目录
├── scripts/                    # 脚本目录
├── src/                        # 源代码目录
├── .github/                    # GitHub 工作流和配置文件
├── .husky/                     # Git 钩子配置目录
├── .vscode/                    # Visual Studio Code 配置文件
├── editorconfig                # 编辑器配置文件
├── eslintignore                # ESLint 忽略文件
├── eslintrc.js                 # ESLint 配置文件
├── gitignore                   # Git 忽略文件
├── markdownlint.yml            # Markdown 语法检查配置文件
├── nvmrc                       # Node.js 版本管理配置文件
├── LICENSE                     # 项目许可证文件
├── README.md                   # 项目说明文件
├── SECURITY.md                 # 项目安全说明文件
├── electron-builder.yml        # Electron 打包配置文件
├── package-lock.json           # npm 包依赖锁定文件
├── package.json                # npm 包配置文件
├── tsconfig.json               # TypeScript 配置文件

2. 项目的启动文件介绍

Deadbolt 项目的启动主要依赖于 package.json 文件中的 scripts 字段定义的脚本。以下是 package.json 中的部分内容：

{
  "scripts": {
    "start": "electron .",
    ...
  },
  ...
}

启动项目时，可以在项目根目录下运行以下命令：

npm start

这条命令会使用 Electron 运行项目根目录下的主进程文件，通常是 src/index.js。

3. 项目的配置文件介绍

Deadbolt 项目的配置文件主要包括以下几个：

• package.json：npm 包的配置文件，定义了项目的依赖、脚本和元数据等信息。
• tsconfig.json：TypeScript 配置文件，定义了 TypeScript 编译器的选项。
• .eslintrc.js：ESLint 配置文件，定义了代码风格检查的规则。
• .editorconfig：编辑器配置文件，定义了不同编辑器通用的代码风格设置。
• electron-builder.yml：Electron 打包配置文件，用于配置如何将 Electron 应用打包成可执行文件。

这些配置文件是项目能够正常编译、运行和打包的关键。用户可能需要根据自己的开发环境和需求对其中的一些配置进行修改。