Skip to content

docs: add electron installation guide #155

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

Merged
merged 3 commits into from
Jan 6, 2024
Merged

docs: add electron installation guide #155

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
756e09c
docs: add electron installation guide
baiwusanyu-c Jan 5, 2024
957f8e6
chore: updated description content
baiwusanyu-c Jan 5, 2024
e54aa2d
chore: update
webfansplz Jan 6, 2024
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
11 changes: 11 additions & 0 deletions docs/guide/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ After cloning the repo, run:
$ pnpm i # install the dependencies of the project
```

:::tip ⚠️

Since `electron` is used in the project, if your network environment is unstable, you may be unable to install dependencies.
You can use the following command to set up the mirror, and run `pnpm i` again to install the dependencies.

```bash
pnpm config set ELECTRON_MIRROR https://npmmirror.com/mirrors/electron/
```

:::

## Git Hooks

The project uses [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) to enforce the following on each commit:
Expand Down