clone/logseq
1
0
Fork 0
mirror of https://github.com/logseq/logseq.git synced 2026-04-24 22:25:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: add Windows develop instruction

Browse Source
This commit is contained in:
Junyi Du
2022-02-18 22:05:46 +08:00
committed by Tienson Qin
parent bd1e1346f4
commit 241132613a
2 changed files with 58 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -76,10 +76,10 @@ Logseq is also made possible by the following projects:
The following is for developers and designers who want to build and run Logseq locally and contribute to this project.
We have [a dedicated overview page](https://github.com/logseq/logseq/blob/master/CODEBASE_OVERVIEW.md) for LogSeq's codebase overview and [a development practices page](docs/dev-practices.md).
We have [a dedicated overview page](https://github.com/logseq/logseq/blob/master/CODEBASE_OVERVIEW.md) for Logseq's codebase overview and [a development practices page](docs/dev-practices.md).
## Set up development environment
* The following instructions are for setting up web app / desktop app development environment on macOS / Linux. For other cases like Windows users or mobile development, please refer to [Docs directory](docs/)
### 1. Requirements
- [Node.js](https://nodejs.org/en/download/) (See [build.yml](.github/workflows/build.yml) for allowed version) & [Yarn](https://classic.yarnpkg.com/en/docs/install/)

56
docs/Develop LogSeq on Windows.md Normal file
View File

@@ -0,0 +1,56 @@
# Build Logseq Desktop on Windows
## Intro
This is a guidance on creating Logseq development environment on Windows with `PowerShell`. Non-platform specific instructions like [this section in README.md](https://github.com/logseq/logseq/blob/master/README.md#set-up-development-environment) **should also be referenced** in the practice.
## Pre-requisites
* Ensure `Set-ExecutionPolicy Unrestricted` (or other equivalent)
* Good network connection. Here's [An example of setting up proxy in PowerShell](#an-example-of-setting-up-proxy-in-powershell)
* Node.js 16.x
* Clojure (follow this [Guidance](https://clojure.org/guides/getting_started#_installation_on_windows))
* JRE 8 (required for Clojure)
(updated 20220218. May confirm via JAVA_VERSION and NODE_VERSION in [THIS FILE](https://github.com/logseq/logseq/blob/master/.github/workflows/build.yml))
### An example of installing pre-requisites on Windows
* Install [Chocolatey](https://chocolatey.org/)
* Install JRE
* `choco install nvm`
* `nvm install 16.13` (or whatever version)
* `nvm use 16.13`
* `npm install -g yarn`
* `nvm use 16.13`
* Install [clj-on-windows](https://github.com/clojure/tools.deps.alpha/wiki/clj-on-Windows)
Congrats! The pre-requisites are ready.
## Set-up development environment (web app)
The basic idea is replacing the `clojure` commands in [package.json](https://github.com/logseq/logseq/blob/master/package.json) to `clj`.
Go to your cloned Logseq repo. Then:
* `yarn` (to install dependencies. Refer [THIS](#an-example-of-setting-up-proxy-in-powershell) if you want to setup proxy)
* `clj -M:cljs watch app electron` (the `clj` equivalent of `yarn cljs:watch`)
Now you can access the app via `http://localhost:3001` and all changes to the code will be watched.
## Set-up development environment (desktop)
* `yarn`
* `clj -M:cljs release app publishing electron --debug` (the `clj` equivalent of `yarn release`, to build the app into `static` directory)
* `cd static`
* `yarn`
* `cd ..`
Then do the `gulp`'s job manually (as it's not available on Windows). Folloing commands are equivalent to `yarn dev-electron-app`:
* copy files in `resources` to `static`
* `yarn css:build`
* `cd static`
* `yarn electron:dev`
The desktop app should be pop-up on your screen.
## An example of setting up proxy in PowerShell
```
$env:GLOBAL_AGENT_HTTPS_PROXY='http://<proxy-host>:<proxy-port>'
$env:ELECTRON_GET_USE_PROXY='true'
$env:HTTPS_PROXY='http://<proxy-host>:<proxy-port>'
$env:HTTP_PROXY='http://<proxy-host>:<proxy-port>'
```