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

chore: update overview docs

pull/10981/head
Gabriel Horner 2024-08-09 14:05:08 -04:00
parent 261118d4dc
commit 31c6cd3f5d
1 changed files with 22 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
CODEBASE_OVERVIEW.md
View File

@ -30,30 +30,41 @@ For other tasks like bundling static resources and building the desktop app, whi
[DataScript](https://github.com/tonsky/datascript) is an in-memory database that implements the [Datalog](https://en.wikipedia.org/wiki/Datalog) logic programming language. Datalog is very different from and much more expressive than the more common SQL and NoSQL query languages. Many users have implemented interesting features on top of Logseq just by utilizing the rich query language. Get started with Datalog with this [tutorial](http://www.learndatalogtoday.org/)
## Important Folders and Files
## Important Directories and Files
After cloning the [Logseq repository](https://github.com/logseq/logseq), there are some folders and files that deserve extra attention.
This is overview of this repository's most important directories and files.
- Config files are located at the root directory. `package.json` contains the JavaScript dependencies while `deps.edn` contains their Clojure counterparts. `shadow-cljs.edn` and `gulpfile.js` contain all the build scripts.
- Config files are located at the root directory. `package.json` contains the JavaScript dependencies while `deps.edn` contains their ClojureScript counterparts. `shadow-cljs.edn` and `gulpfile.js` contain all the build scripts.
- `public/` and `resources/` contain all the static assets
- `resources/` and `public` contain all the static assets
- `src/` is where most of the code is located.
- `src/electron/` and `src/main/electron/` contains code specific to the desktop app.
- `src/electron/` contains code specific to the Electron desktop app.
- `src/test/` contains all the tests and `src/dev-cljs/` contains some development utilities.
- `src/test/` contains all the cljs tests.
- `src/resources/` - directory and classpath for resources used by Clojure(Script)
- `src/main/frontend/` contains code that powers the Logseq editor. Folders and files inside are organized by features or functions. For example, `components` contains all the UI components and `handler` contains all the event-handling code. You can explore on your own interest.
- `src/resources/` is a directory and Clojure(Script) resource classpath and includes language translations.
- `src/main/frontend/` contains code that powers the Logseq editor. Directories and files inside are organized by features or functions. Some notable directories:
- `src/main/frontend/components/` contains all the UI components.
- `src/main/frontend/handler/` contains system component like code.
- `src/main/frontend/worker/` contains code for the separate worker asset.
- `src/main/frontend/common/` contains common code shared by the worker asset and the frontend.
- `src/main/logseq/` contains the api used by plugins.
- `src/dev-cljs/` contains some development utilities.
- `deps/` contains dependencies or libraries used by the frontend.
- `deps/` contains ClojureScript dependencies or libraries used by the frontend.
- `deps/graph-parser/` is a library that parses a Logseq graph and saves it to a database.
- `packages/` contains JavaScript dependencies used by the frontend
- `packages/ui/` - The frontend's component system based on shadcn
- `packags/tldraw/` - Custom fork of tldraw which powers whiteboards
- `scripts` - Dev scripts
- `e2e-tests/` - end to end frontend tests
- `android/` - Android app
- `ios/` - iOS app
## Data Flow
### Application State