2020-11-12 03:39:03 +00:00
# Logseq
2020-11-12 08:54:57 +00:00
[](https://github.com/logseq/logseq/releases)
[](https://github.com/logseq/logseq/blob/master/LICENSE.md)
[](https://twitter.com/logseq)
[](https://discord.gg/KpN4eHY)
[](https://opencollective.com/logseq)
[](https://opencollective.com/logseq)
[](https://opencollective.com/logseq)
2020-11-12 04:01:50 +00:00
A local-first, non-linear, outliner notebook for organizing and sharing your personal knowledge base.
2020-11-12 03:39:03 +00:00
2020-11-12 04:01:50 +00:00
Use it to organize your todo list, to write your journals, or to record your unique life.
2020-11-12 03:39:03 +00:00
2021-06-02 16:48:32 +00:00
< a href = "https://www.producthunt.com/posts/logseq?utm_source=badge-review&utm_medium=badge&utm_souce=badge-logseq#discussion-body" target = "_blank" > < img src = "https://api.producthunt.com/widgets/embed-image/v1/review.svg?post_id=298158&theme=light" alt = "Logseq - Your joyful, private digital garden | Product Hunt" style = "width: 250px; height: 54px;" width = "250" height = "54" / > < / a >
2021-06-02 01:34:02 +00:00
## [Download our free Desktop app](https://github.com/logseq/logseq/releases)
[Sponsor our contributors on Open Collective ](https://opencollective.com/logseq ), Logseq will move to Stripe later!
2020-11-12 04:01:50 +00:00
## Why Logseq?
2021-05-19 16:07:42 +00:00
[Logseq ](https://logseq.com ) is a platform for knowledge management and collaboration. It focuses on privacy, longevity, and [user control ](https://www.gnu.org/philosophy/free-sw.en.html ).
2020-11-12 04:01:50 +00:00
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).
In the unlikely event that the website is down or cannot be maintained, your data is, and will always be yours.
2021-04-09 13:00:42 +00:00
## Sponsors
Our top sponsors are shown below! [[Become a sponsor ](https://opencollective.com/logseq#sponsor )]
2021-04-09 13:04:22 +00:00
< a href = "https://www.deta.sh/" target = "_blank" > < img width = 200 height = 100 src = "https://uploads-ssl.webflow.com/5eb96efa78dc680fc15be3be/5ebd24f6cbf6e9ebd674656e_Logo.svg" / > < / a >
2021-04-09 13:00:42 +00:00
2021-06-15 13:27:25 +00:00
## Plugins documentation (Draft)
The plugins documentation is at https://logseq.github.io/plugins. Any feedback would be greatly appreciated!
2020-12-15 03:10:23 +00:00
## Feature requests
2021-03-02 05:57:16 +00:00
2020-12-15 03:10:23 +00:00
Please go to https://discuss.logseq.com/c/feature-requests/7.
2020-11-12 04:01:50 +00:00
## How can I use it?
2021-08-07 07:18:30 +00:00
1. Download the desktop app at https://github.com/logseq/logseq/releases.
2. Start writing and have fun!
2020-11-12 04:01:50 +00:00
2021-08-07 07:18:30 +00:00
## FAQ
2021-08-09 12:52:05 +00:00
Please go to https://logseq.github.io/#/page/faq.
2020-11-12 04:01:50 +00:00
## Credits
Logseq is hugely inspired by [Roam Research ](https://roamresearch.com/ ), [Org Mode ](https://orgmode.org/ ), [Tiddlywiki ](https://tiddlywiki.com/ ), [Workflowy ](https://workflowy.com/ ) and [Cuekeeper ](https://github.com/talex5/cuekeeper ), hats off to all of them!
Logseq is also made possible by the following projects:
- [Clojure & ClojureScript ](https://clojure.org/ ) - A dynamic, functional, general-purpose programming language
- [DataScript ](https://github.com/tonsky/datascript ) - Immutable database and Datalog query-engine for Clojure, ClojureScript and JS
- [OCaml ](https://ocaml.org/ ) & [Angstrom ](https://github.com/inhabitedtype/angstrom ), for the document [parser ](https://github.com/mldoc/mldoc )
- [isomorphic-git ](https://isomorphic-git.org/ ) - A pure JavaScript implementation of Git for node and browsers
- [sci ](https://github.com/borkdude/sci ) - Small Clojure Interpreter
2020-11-12 10:50:22 +00:00
2020-11-12 04:01:50 +00:00
## Learn more
- Our blog: https://logseq.com/blog - Please be sure to visit our [About page ](https://logseq.com/blog/about ) for the latest updates of the app
- Twitter: https://twitter.com/logseq
2021-03-30 22:27:23 +00:00
- Discord: https://discord.gg/KpN4eHY - Where we answer questions, discuss workflows and share tips
2021-05-30 03:29:36 +00:00
- 中文 Discord：
2020-11-12 04:01:50 +00:00
- Github: https://github.com/logseq/logseq - everyone is encouraged to report issues!
2021-03-02 05:57:16 +00:00
---
2020-11-12 04:01:50 +00:00
2020-11-12 10:50:22 +00:00
The following is for developers and designers who want to build and run Logseq locally and contribute to this project.
2020-11-12 03:39:03 +00:00
2021-03-03 03:17:33 +00:00
We also have [a dedicated page ](https://github.com/logseq/logseq/blob/master/CODEBASE_OVERVIEW.md ) for LogSeq's codebase overview.
2020-11-12 03:39:03 +00:00
## Set up development environment
### 1. Requirements
2020-11-12 04:01:50 +00:00
- [Node.js ](https://nodejs.org/en/download/ ) & [Yarn ](https://classic.yarnpkg.com/en/docs/install/ )
2021-01-14 15:55:15 +00:00
- [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.)
2020-11-12 03:39:03 +00:00
2020-12-02 13:57:16 +00:00
### 2. Compile to JavaScript
2020-11-12 03:39:03 +00:00
2021-03-02 05:57:16 +00:00
```bash
2020-11-27 13:34:48 +00:00
git clone https://github.com/logseq/logseq
2021-06-12 23:41:34 +00:00
cd logseq
2020-11-12 03:39:03 +00:00
yarn
yarn watch
```
2020-12-02 13:57:16 +00:00
### 3. Open the browser
2020-11-12 03:39:03 +00:00
2020-12-02 13:57:16 +00:00
Open < http: / / localhost:3001 > .
2020-11-26 06:18:57 +00:00
2020-12-04 08:17:07 +00:00
### 4. Build a release
2021-03-02 05:57:16 +00:00
```bash
2021-02-02 13:32:34 +00:00
yarn release
2020-12-04 08:17:07 +00:00
```
2020-12-21 11:07:17 +00:00
2021-01-21 15:19:42 +00:00
### 5. Run tests
Run ClojureScript tests
2021-03-02 05:57:16 +00:00
2021-01-21 15:19:42 +00:00
```bash
2021-03-02 05:58:01 +00:00
yarn test
2021-01-21 15:19:42 +00:00
```
2021-06-16 08:49:25 +00:00
Run Cypress tests
``` bash
yarn e2e-test
```
2021-01-21 15:19:42 +00:00
Run Clojure tests. (Note: `.cljc` files may be tested both by ClojureScript, and Clojure.)
2021-03-02 05:57:16 +00:00
2021-01-21 15:19:42 +00:00
```bash
clj -Mtest-clj
```
2021-01-28 12:16:44 +00:00
## Desktop app development
### 1. Compile to JavaScript
2021-03-02 05:57:16 +00:00
```bash
2021-01-28 12:16:44 +00:00
yarn watch
```
2021-02-07 05:41:09 +00:00
### 2. Open the dev app
2021-01-28 12:16:44 +00:00
2021-03-02 05:57:16 +00:00
```bash
2021-02-07 05:41:09 +00:00
yarn dev-electron-app
2021-01-28 12:16:44 +00:00
```
### 3. Build a release
2021-03-02 05:57:16 +00:00
```bash
2021-01-28 12:16:44 +00:00
yarn release-electron
```
2020-12-21 11:07:17 +00:00
## Alternative: Docker based development environment
2021-03-02 06:15:14 +00:00
Basically it just pre-installs Java, Clojure and NodeJS for your convenience.
2020-12-21 11:07:17 +00:00
### 1. Fetch sources
2021-03-02 05:57:16 +00:00
```bash
2020-12-21 11:07:17 +00:00
git clone https://github.com/logseq/logseq
```
### 2. Build Docker image
2021-03-02 05:57:16 +00:00
```bash
2020-12-21 11:07:17 +00:00
cd logseq
docker build -t logseq-docker .
```
### 3. Run Docker container
2021-03-02 05:57:16 +00:00
```bash
2020-12-21 11:07:17 +00:00
docker run -v $(pwd):/home/logseq/logseq -p 3001:3001 -p 9630:9630 -p 8701:8701 --rm -it logseq-docker /bin/bash
```
### 4. Inside the container compile as described above
2021-03-02 05:57:16 +00:00
```bash
2020-12-21 11:07:17 +00:00
cd logseq
yarn
yarn watch
```
2021-01-19 01:38:18 +00:00
## Thanks
2021-01-20 16:19:09 +00:00
[](https://www.jetbrains.com/?from=logseq)
