Excalidraw Desktop 项目启动与配置教程

1. 项目目录结构及介绍

Excalidraw Desktop 的目录结构如下：

excalidraw-desktop/
├── assets/                     # 存储项目静态资源，如图标、图片等
├── dist/                       # 构建后的文件存放目录
├──-electron/                   # Electron 相关的代码和配置文件
│   ├── preload.js              # 预加载脚本
│   └── main.js                 # 主进程脚本
├── packages/                   # 包含可共享的代码模块
├── src/                        # 源代码目录
│   ├── components/             # React 组件
│   ├── hooks/                  # 自定义 React 钩子
│   ├── pages/                  # 页面组件
│   ├── styles/                 # 样式文件
│   └── utils/                  # 工具函数
├── tests/                      # 测试目录
├── public/                     # 公共文件目录
│   ├── index.html              # HTML 入口文件
│   └── ...                     # 其他静态资源
├── .gitignore                  # Git 忽略文件
├── .vscode/                    # VSCode 项目配置
├── package.json                # 项目依赖和配置
└── ...                         # 其他文件和目录

2. 项目的启动文件介绍

项目的启动主要依赖于 package.json 文件中定义的脚本。以下是主要的启动脚本：

• start: 用于启动开发服务器，通常用于开发和测试。
• build: 用于构建生产环境的应用程序。
• pack: 用于打包应用程序。

在 package.json 中，可能会看到如下脚本配置：

"scripts": {
  "start": "react-scripts start",
  "build": "react-scripts build",
  "pack": "electron-packager . --overwrite --asar --platform=win32 --arch=x64 --icon=assets/icon.ico --prune=true --out=release-builds"
}

要启动开发服务器，你可以在项目根目录下运行以下命令：

npm start

这将启动一个热重载的开发服务器，并在默认的网络浏览器中打开 http://localhost:3000。

3. 项目的配置文件介绍

项目的配置文件主要集中在 package.json 中，以下是主要的配置项：

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 指定应用程序的入口点。
• scripts: 定义了可以运行的脚本命令。
• dependencies: 项目依赖的库。
• devDependencies: 开发环境中依赖的库。

例如：

{
  "name": "excalidraw-desktop",
  "version": "1.0.0",
  "description": "A desktop version of Excalidraw using Electron.",
  "main": "-electron/main.js",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "pack": "electron-packager . --overwrite --asar --platform=win32 --arch=x64 --icon=assets/icon.ico --prune=true --out=release-builds"
  },
  "dependencies": {
    // ... 依赖列表
  },
  "devDependencies": {
    // ... 开发依赖列表
  }
}

main 字段指定了应用程序的主进程文件，这里是 electron/main.js，它是 Electron 应用的入口点。

在配置文件中可能还会有其他配置项，具体取决于项目的需求和所使用的工具。