logseq/docs/develop-logseq.md

59 lines
1.4 KiB
Markdown
Raw Normal View History

# Develop Logseq
## Requirements
2022-03-17 17:33:31 +00:00
- [Node.js](https://nodejs.org/en/download/) (See [build.yml](https://github.com/logseq/logseq/blob/master/.github/workflows/build.yml) for allowed version) & [Yarn](https://classic.yarnpkg.com/en/docs/install/)
- [Java & Clojure](https://clojure.org/guides/getting_started). (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
2022-02-23 14:49:41 +00:00
This is a required step before doing any development or production builds.
```bash
git clone https://github.com/logseq/logseq
cd logseq
```
## Browser development
### Development
```bash
yarn
yarn watch
```
Then open the browser <http://localhost:3001>.
### Production
```bash
yarn release
```
## Desktop app development
### Development
1. Install npm packages for building the desktop app
``` bash
yarn install && cd static && yarn install && cd ..
```
2. Compile to JavaScript and open the dev app
```bash
yarn watch
# Wait until watch is finished building and then in a different shell
yarn dev-electron-app
```
2022-02-23 14:49:41 +00:00
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:
```bash
yarn release-electron
```