logseq/docs/develop-logseq.md

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

yarn release

Desktop app development

Development

1. Install npm packages for building the desktop app

   yarn install && cd static && yarn install && cd ..
   

2. Compile to JavaScript and open the dev app

   yarn watch
   # Wait until watch is finished building and then in a different shell
   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.

Production

Build a release:

yarn release-electron