vikunja/desktop
renovate[bot] bb0055293b chore(deps): update pnpm to v10.34.4 2026-06-29 16:14:58 +00:00
..
build feat: update application icons for desktop build (#2516) 2026-04-01 23:38:02 +02:00
.gitignore chore: move desktop files 2024-02-08 14:53:56 +01:00
CHANGELOG.md chore: release preparation 2024-02-10 14:46:33 +01:00
LICENSE fix: correct license header references (#882) 2025-06-10 12:18:38 +02:00
README.md docs(desktop): fix release version instruction 2025-06-10 12:10:42 +02:00
build.js fix(ci): fix unstable suffix not renamed for desktop release builds 2025-12-16 22:35:49 +01:00
cliff.toml chore: move desktop files 2024-02-08 14:53:56 +01:00
icon.png fix(desktop): show tray icon in packaged builds 2026-05-30 13:30:55 +00:00
main.js fix(desktop): set the main window icon on Linux 2026-06-27 14:12:10 +00:00
oauth.js feat: add OAuth PKCE authentication flow to desktop app 2026-03-30 20:12:25 +00:00
package.json chore(deps): update pnpm to v10.34.4 2026-06-29 16:14:58 +00:00
pnpm-lock.yaml chore(deps): pin dependencies 2026-06-27 18:01:23 +00:00
portInUse.js chore: move desktop files 2024-02-08 14:53:56 +01:00
preload-quick-entry.js feat(desktop): open task in main window with Ctrl/Cmd+Enter 2026-04-01 21:38:38 +00:00
preload.js feat(frontend): add configurable quick entry shortcut setting 2026-04-01 21:38:38 +00:00

README.md

Vikunja desktop

License: GPL-3.0-or-later

The Vikunja frontend all repackaged as an electron app to run as a desktop app!

Dev

As this package does not contain any code, only a thin wrapper around electron, you will need to do this to get the actual frontend bundle and build the app:

First, build the frontend:

cd ../frontend
pnpm install
pnpm run build

Then, copy the frontend to this directory:

cd desktop
cp -r ../frontend/dist frontend/
sed -i 's/\/api\/v1//g' frontend/index.html # Make sure to trigger the "enter the Vikunja url" prompt

Then you can run the desktop app like this:

pnpm install
pnpm start

Building for release

  1. Run the snippet from above, but with a valid frontend version instead of unstable
  2. Change the version in package.json (that's the one that will be used by electron-builder)
  3. pnpm install
  4. pnpm run dist --linux --windows

License

This project is licensed under the GPL-3.0-or-later license. See the LICENSE file for details.