Skip to content

Commit

Permalink
docs: add desktop app development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tiensonqin committed Jan 28, 2021
1 parent 00a9939 commit a458635
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
22 changes: 21 additions & 1 deletion README.md
Expand Up @@ -16,7 +16,7 @@ Use it to organize your todo list, to write your journals, or to record your uni
## Why Logseq?

[Logseq](https://logseq.com) is a platform for knowledge sharing and management. It focuses on privacy, longevity, and user control.
Notice: the backend code will not be open-sourced for security reasons and other potential risks.
Notice: the backend code will not be open-sourced for security reasons and other potential risks.

The server will never store or analyze your private notes. Your data are plain text files and we currently support both Markdown and Emacs Org mode (more to be added soon).

Expand Down Expand Up @@ -103,6 +103,26 @@ Run Clojure tests. (Note: `.cljc` files may be tested both by ClojureScript, and
clj -Mtest-clj
```

## Desktop app development

### 1. Compile to JavaScript

``` bash
yarn watch
```

### 2. Open the debug app

``` bash
yarn debug-electron
```

### 3. Build a release

``` bash
yarn release-electron
```

## Alternative: Docker based development environment

### 1. Fetch sources
Expand Down
5 changes: 3 additions & 2 deletions package.json
Expand Up @@ -33,8 +33,8 @@
"release-publishing": "run-s gulp:build cljs:release-publishing",
"dev-release-app": "run-s gulp:build cljs:dev-release-app",
"dev-electron-app": "gulp electron",
"release-electron-app": "gulp electronMaker",
"debug-electron-app": "cd static/ && yarn electron:debug",
"release-electron": "run-p cljs:electron-release && cd ./static && yarn electron:make",
"debug-electron": "cd static/ && yarn electron:debug",
"clean": "gulp clean",
"test": "run-s cljs:test cljs:run-test",
"report": "run-s cljs:report",
Expand All @@ -44,6 +44,7 @@
"cljs:watch": "clojure -M:cljs watch app publishing electron",
"cljs:electron-watch": "clojure -M:cljs watch app electron",
"cljs:release": "clojure -M:cljs release app publishing electron",
"cljs:electron-release": "clojure -M:cljs release app --config-merge '{:release {:asset-path \"./js\"}}' publishing electron",
"cljs:test": "clojure -A:test compile test",
"cljs:run-test": "node static/tests.js",
"cljs:watch-app": "clojure -M:cljs watch app",
Expand Down

0 comments on commit a458635

Please sign in to comment.