vikunja/desktop
renovate[bot] 68a5c5e2a5
chore(deps): update dev-dependencies (#1252)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-08-07 08:20:55 +02:00
..
build chore: move desktop files 2024-02-08 14:53:56 +01: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: correct license header references (#882) 2025-06-10 12:18:38 +02:00
cliff.toml chore: move desktop files 2024-02-08 14:53:56 +01:00
main.js fix(desktop): use app.use to serve frontend files 2025-05-20 15:48:02 +02:00
package.json chore(deps): update dev-dependencies (#1252) 2025-08-07 08:20:55 +02:00
pnpm-lock.yaml chore(deps): update dev-dependencies (#1252) 2025-08-07 08:20:55 +02:00
portInUse.js chore: move desktop files 2024-02-08 14:53:56 +01: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.