Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-12-20 15:19:56 +01:00
Code Issues Packages Projects Releases Activity

docs(dev): update recent technical documentation

Browse Source
This commit is contained in:
Elian Doran
2025-11-03 22:16:15 +02:00
parent 4a47ff2ea0
commit d9071f2d8e
85 changed files with 1449 additions and 1790 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/Developer Guide/Developer Guide/Project Structure.md vendored
View File

@@ -1,5 +1,5 @@
# Project Structure
As the application grew in complexity, our build system was growing even more difficult to maintain and was spread across multiple repositories. As such we have decided to use a mono-repo approach, and to do so we chose to have NX manage our mono-repo.
As the application grew in complexity, we decided to switch to a monorepo based on `pnpm`. Our initial monorepo implementation used NX, but we've switched to pure `pnpm` workspaces and our own build scripts.
## Project structure
@@ -12,45 +12,34 @@ The mono-repo is mainly structured in:
* `packages`, containing dependencies used by one or more `apps`.
* `commons`, containing shared code for all the apps.
## Working with NX
### Running tasks via the CLI
## Working with the project
For example to run the server instance:
```
pnpm exec nx run server:serve
pnpm server:start
```
NX has built-in cache support which should make development much faster. Sometimes, it can get in the way; to skip the cache simply append `--skip-nx-cache` to the command you are running.
### Running tasks using Visual Studio Code
If you are using Visual Studio Code as your development tool for Trilium, consider using the NX Console. It allows running tasks/targets much easier via the dedicated tab. Right-click a target in the list for more options, such as bypassing the cache.
## Important tasks
Each application has a number of tasks (called _targets_ by NX). Here's a non-exhaustive list of the tasks that are useful during development.
Each application has a number of tasks. Here's a non-exhaustive list of the tasks that are useful during development.
To run any of the task use `pnpm exec nx run project:task`, or use the Visual Studio Code integration as described above.
To run any of the tasks, use `pnpm project:task`:
* `client`:
* The client is not meant to be run by itself, despite being described as an app. See the documentation on the server instead.
* `server`:
* To run the server in development mode, run `client:serve` (which will only serve the public assets), followed by `server:serve` (which will proxy the assets of the client as well). The dev port remains the same as always, `8080`.
* To run the server in development mode, run `server:start`. The dev port is `8080`.
* To run the server in production mode (with its own copy of the assets), run `server:start-prod`.
* To build the server for Docker, run `docker-build` which will automatically build and tag the image if Docker is installed locally.
* Similarly, run `docker-start` to build and run the Docker image.
* To build for Docker, see <a class="reference-link" href="Building/Docker.md">Docker</a>.
* `desktop`:
* To run the desktop, run `desktop:serve`.
* Unlike the server, this one does not require the client since it will automatically get a production copy of it. The only downside is that modifications to the code will only take effect after restarting the task.
* To run the desktop in development mode with watch, run `desktop:start`.
* To run the desktop in production mode, run `desktop:start-prod`.
## Building packages
Generally, the building process of a project generates a `dist` folder containing everything needed for production. To trigger a build run `pnpm nx build project` where `project` is the name of a project from either `apps` or `packages`.
Generally, the building process of a project generates a `dist` folder containing everything needed for production.
## Managing dependencies across the mono-repo
We are using [pnpm workspaces](https://pnpm.io/workspaces) to manage the project structure, further augmented by NX which is described in a different section.
The workspace configuration is in `pnpm-workspace.yaml` at project level but it generally should not be modified.
We are using [pnpm workspaces](https://pnpm.io/workspaces) to manage the project structure. The workspace configuration is in `pnpm-workspace.yaml` at project level but it generally should not be modified.