public-backup/vikunja-github
1
0
Fork 0
mirror of https://github.com/go-vikunja/vikunja.git synced 2025-12-05 18:57:47 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
vikunja-github/desktop/README.md
Dominik Pschenitschni 69e5223fa5 docs(desktop): fix release version instruction
2025-06-10 12:10:42 +02:00

1.1 KiB
Raw Permalink Blame History

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.