Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 1.85 KB

develop-logseq.md

File metadata and controls

77 lines (51 loc) · 1.85 KB
Raw

Develop Logseq

Requirements

  • Node.js (See build.yml for allowed version) & Yarn
  • Java & Clojure. (If you run into Execution error (FileNotFoundException) at java.io.FileInputStream/open0 (FileInputStream.java:-2). -M:cljs (No such file or directory), it means you have a wrong Clojure version installed. Please uninstall it and follow the instructions linked.)

Clone project

This is a required step before doing any development or production builds.

git clone https://github.com/logseq/logseq
cd logseq

Browser development

Development

yarn
yarn watch

Then open the browser http://localhost:3001.

Production Build

yarn release

The released files will be at resources/ directory.

Desktop app development

Development

  1. Install npm packages for building the desktop app
yarn install
  1. Compile to JavaScript and open the dev app
yarn watch
# Wait until watch reports `Build Completed.` for `:electron` and `:app`.
# Then, run the following command in a different shell.
# If you have opened desktop logseq, you should close it. Otherwise, this command will fail.
yarn dev-electron-app

Alternatively, run bb dev:electron-start to do this step with one command. To download bb, see https://github.com/babashka/babashka#installation.

  1. (Optional) Update dependencies if your are updating from an old branch
# pull new changes
git pull

cd static && yarn install && cd ..

Here static/ is generated by yarn watch command.

Production Build

Build a release:

yarn release-electron

The final released binaries or installers will be at static/out/.