chore(docs): restructure developer guide for monorepo
@ -0,0 +1,33 @@
|
||||
# Environment Setup
|
||||
## Setting up `pnpm`
|
||||
|
||||
Trilium uses the `pnpm` package manager in order to better manage its mono-repo structure. Unlike `npm` which comes by default with Node.js, `pnpm` needs to be manually activated.
|
||||
|
||||
For most systems this can be achieved via `corepack`:
|
||||
|
||||
```
|
||||
corepack enable
|
||||
```
|
||||
|
||||
After that, run `pnpm` in a new terminal to see if it is working. On Windows, if you get:
|
||||
|
||||
```
|
||||
pnpm : The term 'pnpm' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
|
||||
```
|
||||
|
||||
The solution is to run `corepack enable` in a Terminal with administrative rights.
|
||||
|
||||
As a quick heads-up of some differences when compared to `npm`:
|
||||
|
||||
* Generally instead of `npm run` we have `pnpm run` instead.
|
||||
* Instead of `npx` we have `pnpm exec`.
|
||||
|
||||
## Installing dependencies
|
||||
|
||||
Run `pnpm i` at the top of the `Notes` repository to install the dependencies.
|
||||
|
||||
## IDE
|
||||
|
||||
Our recommended IDE for working on TriliumNext is Visual Studio Code (or VSCodium if you are looking for a fully open-source alternative).
|
||||
|
||||
By default we include a number of suggested extensions which should appear when opening the repository in VS Code. Most of the extensions are for integrating various technologies we are using such as Playwright and Vitest for testing and NX for mono-repo management.
|
||||
@ -1,2 +0,0 @@
|
||||
# Releasing a version
|
||||
This is a clone of a note. Go to its [primary location](../Building%20and%20deployment/Releasing%20a%20version.md).
|
||||
@ -1,2 +0,0 @@
|
||||
# Running a development build
|
||||
This is a clone of a note. Go to its [primary location](../Building%20and%20deployment/Running%20a%20development%20build.md).
|
||||
@ -1,2 +1,2 @@
|
||||
# Build deliveries locally
|
||||
This is a clone of a note. Go to its [primary location](../Building%20and%20deployment/Build%20deliveries%20locally.md).
|
||||
This is a clone of a note. Go to its [primary location](../Build%20deliveries%20locally.md).
|
||||
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 8.4 KiB |
@ -0,0 +1,2 @@
|
||||
# Releasing a version
|
||||
This is a clone of a note. Go to its [primary location](../Releasing%20a%20version.md).
|
||||
@ -0,0 +1,2 @@
|
||||
# Running a development build
|
||||
This is a clone of a note. Go to its [primary location](../Running%20a%20development%20build.md).
|
||||
@ -1,4 +1,4 @@
|
||||
# Build information
|
||||
* Provides context about when the build was made and the corresponding Git revision.
|
||||
* The information is displayed to the client when going in the about dialog.
|
||||
* The build information is hard-coded in `src/services/build.ts`. This file is generated automatically via `npm run update-build-info` which itself is run automatically whenever making a build in the CI, or a [local delivery](../Building%20and%20deployment/Build%20deliveries%20locally.md).
|
||||
* The build information is hard-coded in `src/services/build.ts`. This file is generated automatically via `npm run update-build-info` which itself is run automatically whenever making a build in the CI, or a [local delivery](../Build%20deliveries%20locally.md).
|
||||
|
Before Width: | Height: | Size: 233 KiB After Width: | Height: | Size: 233 KiB |
|
Before Width: | Height: | Size: 233 KiB After Width: | Height: | Size: 233 KiB |
|
Before Width: | Height: | Size: 748 KiB After Width: | Height: | Size: 748 KiB |
|
Before Width: | Height: | Size: 7.4 KiB After Width: | Height: | Size: 7.4 KiB |
|
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 83 KiB |
|
Before Width: | Height: | Size: 6.5 KiB After Width: | Height: | Size: 6.5 KiB |
|
Before Width: | Height: | Size: 250 KiB After Width: | Height: | Size: 250 KiB |
|
Before Width: | Height: | Size: 7.1 KiB After Width: | Height: | Size: 7.1 KiB |
|
Before Width: | Height: | Size: 251 KiB After Width: | Height: | Size: 251 KiB |
|
Before Width: | Height: | Size: 6.8 KiB After Width: | Height: | Size: 6.8 KiB |
|
Before Width: | Height: | Size: 716 KiB After Width: | Height: | Size: 716 KiB |
|
Before Width: | Height: | Size: 336 KiB After Width: | Height: | Size: 336 KiB |
|
Before Width: | Height: | Size: 7.1 KiB After Width: | Height: | Size: 7.1 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |