greatbody
/
logseq
mirror of https://github.com/logseq/logseq
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
logseq/readme.org

3.1 KiB
Raw Blame History

Logseq

Logseq is A privacy-first, open-source platform for knowledge sharing and management.

Website

https://logseq.com

Setup development environment

If you're on Windows, use the Windows setup.

1. Requirements

Java && Clojure
PostgreSQL
Node.js

2. Creating a GitHub app:

Follow this step: https://docs.github.com/en/free-pro-team@latest/developers/apps/creating-a-github-app. The User authorization callback URL should be: http://localhost:3000/auth/github

Remember to download the private-key.pem which will be used for the next step.

3. Add environment variables 

  export ENVIRONMENT="dev"
  export JWT_SECRET="4fa183cf1d28460498b13330835e80ab"
  export COOKIE_SECRET="10a42ca724e34f4db6086a772d787030"
  export DATABASE_URL="postgres://localhost:5432/logseq"
  export GITHUB_APP2_ID="78728"
  export GITHUB_APP2_KEY="xxxxxxxxxxxxxxxxxxxx"
  export GITHUB_APP2_SECRET="xxxxxxxxxxxxxxxxxxxx"
  # Replace your-code-directory with yours
  export GITHUB_APP_PEM="/your-code-directory/your-app.private-key.pem"
  export LOG_PATH="/tmp/logseq"

4. Compile javascript 

  cd web
  yarn
  yarn watch

5. Start the clojure server 

  cd resources

  # 1. Download jar
  Go to https://github.com/logseq/logseq-internal/releases, download the logseq.jar and move it to the "resources" directory.

  # 2. run jar
  java -Duser.timezone=UTC -jar logseq.jar

6. Open the browser

Open http://localhost:3000.

Windows setup

1. Required software

Install clojure through scoop-clojure: https://github.com/littleli/scoop-clojure. You can also install Node.js, Yarn and PostgreSQL through scoop if you want to.

2. Creating a GitHub app

Follow #2-creating-a-github-app above if you want Logseq to connect to GitHub. If not, skip this section. The GITHUB_APP_PEM variable in the run-windows.bat needs to be set with the correct directory for your system.

3. Setup PostgreSQL

Make sure you have PostgreSQL running. You can check if it's running with pg_ctl status and use pg_ctl start to start it up. You'll also need to make a logseq DB in PostgreSQL. Do that with createdb logseq.

4. Download the clojure server

Go to https://github.com/logseq/logseq-internal/releases, download the logseq.jar and move into the root directory of repo.

5. Start Logseq

Run start-windows.bat which is located in the repo. This will open a second terminal that runs Logseq's backend server. To completely stop Logseq, you'll need to also close that second terminal that was opened.

start-windows.bat will try to start PostgreSQL for you if it's not already started.