logseq

(β˜… 44,548)

A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: https://logseq.io/p/NX4mc_ggEV

  • .cljfmt.edn
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .i18n-lint.toml
  • .npmrc
  • .prettierrc.js
  • .projectile
  • .stylelintrc.json
  • AGENTS.md
  • bb.edn
  • capacitor.config.ts
  • CODE_OF_CONDUCT.md
  • CODEBASE_OVERVIEW.md
  • CONTRIBUTING.md
  • deps.edn
  • Dockerfile
  • externs.js
  • gulpfile.js
  • LICENSE.md
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • postcss.config.js
  • README.md
  • shadow-cljs.edn
  • tailwind.all.css
  • tailwind.config.js
  • tailwind.mobile.css
  • typos.toml
  • webpack.config.js

# Installation Guide

1. Get the code
git clone https://github.com/logseq/logseq

Downloads the entire project code from GitHub to your computer.

cd logseq

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
curl -fsSL https://raw.githubusercontent.com/logseq/logseq/master/scripts/install-linux.sh | bash

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t logseq .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 logseq

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
cd android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd cli

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation