Repository navigation
Building Source
Whether you don't trust my pre-compiled versions, or you want to customize a theme or features, this guide will walk you through the whole process. This guide assumes you know basic project structure and have some sort of text editor on your computer. (I use VS Code)
For this project, we'll need both NodeJS 24+ and Rust on our computer. Once those are both installed, open a new terminal window to refresh the environment variables.
Now we want to enable pnpm, which is the package manager used here on NodeJS. You can do that by opening a terminal in any directory and typing corepack enable pnpm, then pnpm -v and pressing enter.
Now we want to download the source code of the version/type we want. All releases on the releases tab come with a snapshot of the source code in Source code.zip. Otherwise, we can either clone the v2-stable or v2-dev branches. Stable is up-to-date with the latest "release" version of the app (2.0, 2.1, etc.). Dev is the bleeding-edge version where new commits are pushed to. I don't recommend this one unless you want to work on new features (dm me).
If you understand git, go ahead and clone the one you want. For everyone else, you can click here to download a .zip of the current v2-stable branch.
If you downloaded a zip, make a new folder in Documents, and extract it there. Then, open a terminal in that folder (it should have a src folder, README, and a bunch of files).
Once you have a terminal open in the project root, type pnpm i to install npm packages. Once that finishes, type pnpm approve-builds to run post-install scripts for some packages like prisma. Press A on your keyboard to select all and press ENTER to confirm.
If you simply want a built version to use, this is your last step. If you are on Windows, run pnpm tauri:windows. For linux, do pnpm tauri:linux.
Note
For older versions, it may be pnpm tauri build on windows. Linux not supported before 2.0-pre7
This may take a couple minutes depending on how many cores your CPU has, especially on linux (since it builds all linux variants). Once finished, files will be placed in ./src-tauri/target/release.
Use this if you want to test adding new features or making a theme. You can start it by running pnpm tauri dev. This will also take a little while, especially if you haven't run any builds yet.
Once finished, it will open a new window for the app. In this mode, the Inspect Element web-view is enabled in the right-click context menu.