Skip to content

docs(getting-start): 添加 Electron 镜像安装说明 #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Craun718 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(getting-start): 添加 Electron 镜像安装说明 #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4b1289
docs(getting-start): 添加 Electron 镜像安装说明
Craun718 Aug 21, 2026
381fc78
Update en/developer/getting-start.md
Craun718 Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions developer/getting-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,14 @@ cd frontend
yarn install
```

如果 Electron 二进制下载缓慢或失败，可以使用 npmmirror 镜像执行一次性安装：

```bash
yarn cross-env ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" yarn install
```

该命令只为本次 `yarn install` 设置下载源，不会修改全局配置。


### 4. 启动软件

Expand Down Expand Up @@ -225,6 +233,8 @@ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
1. 清理缓存: `yarn cache clean`
2. 删除 `node_modules` 和 `yarn.lock`
3. 重新安装: `yarn install`
4. Electron 二进制下载缓慢或失败时，使用镜像执行一次性安装:
`yarn cross-env ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" yarn install`

### Q: 后端启动失败提示权限不足

Expand Down
10 changes: 10 additions & 0 deletions en/developer/getting-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,14 @@ cd frontend
yarn install
```

If the Electron binary download is slow or fails, use npmmirror for a one-shot install:

```bash
yarn cross-env ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" yarn install
```

This command sets the download source only for this `yarn install` run and does not change global configuration.

### 4. Start the App

::: tip Administrator Privileges
Expand Down Expand Up @@ -221,6 +229,8 @@ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
1. Clear cache: `yarn cache clean`
2. Delete `node_modules` and `yarn.lock`
3. Install again: `yarn install`
4. If the Electron binary download is slow or fails, install once through the mirror:
`yarn cross-env ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" yarn install`

### Q: Backend startup fails due to insufficient permissions

Expand Down