onedeuxtriseigo.nullpo.dev / siyuan
A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang. (PERSONAL FORK)
fork atom
siyuan / .github / CONTRIBUTING.md
at lambda-fork/main 2.2 kB view raw view code
Daniel :recycle: Upgrade to Electron v37.7.1 https://github.com/siyuan-note/siyuan/issues/16097
e3d85113

中文

Get the source code#

  • git clone git@github.com:siyuan-note/siyuan.git
  • Switch to dev branch git checkout dev

NPM dependencies#

Install pnpm: npm install -g pnpm@10.19.0

For China mainland

Set the Electron mirror environment variable and install Electron:

  • macOS/Linux: ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/ pnpm install electron@37.7.1 -D
  • Windows:
    • SET ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
    • pnpm install electron@37.7.1 -D

NPM mirror:

  • Use npmmirror China mirror repository pnpm --registry https://registry.npmmirror.com/ i
  • Revert to using official repository pnpm --registry https://registry.npmjs.org i

Enter the app folder and execute:

  • pnpm install electron@37.7.1 -D
  • pnpm run dev
  • pnpm run start

Note: In the development environment, the kernel process will not be automatically started, and you need to manually start the kernel process first.

Kernel#

  1. Install the latest version of golang
  2. Open CGO support, that is, configure the environment variable CGO_ENABLED=1

Desktop#

  • cd kernel
  • Windows: go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"
  • Linux/macOS: go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel"
  • cd ../app/kernel
  • Windows: ./SiYuan-Kernel.exe --wd=.. --mode=dev
  • Linux/macOS: ./SiYuan-Kernel --wd=.. --mode=dev

iOS#

Android#

Harmony#

Only support compilation under Linux, need to install Harmony SDK, and need to modify Go source code, please refer to https://github.com/siyuan-note/siyuan/issues/13184