clone/vikunja
1
0
Fork 0
mirror of https://github.com/go-vikunja/vikunja.git synced 2026-04-25 06:35:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(desktop): adjust dev instructions

Browse Source 
This change fixes the dev instructions for the desktop electron wrapper.
This commit is contained in:
kolaente
2025-05-20 15:48:34 +02:00
parent dc20d55be6
commit 39d22ea876
1 changed files with 24 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
desktop/README.md
View File

@@ -1,27 +1,40 @@
# Vikunja desktop # Vikunja desktop
[![Build Status](https://drone.kolaente.de/api/badges/vikunja/desktop/status.svg)](https://drone.kolaente.de/vikunja/desktop)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE)
[![Download](https://img.shields.io/badge/download-v0.22.1-brightgreen.svg)](https://dl.vikunja.io)
The Vikunja frontend all repackaged as an electron app to run as a desktop app! The Vikunja frontend all repackaged as an electron app to run as a desktop app!
## Dev ## Dev
As this repo does not contain any code, only a thin wrapper around electron, you will need to do this to get the 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: actual frontend bundle and build the app:
```bash First, build the frontend:
rm -rf frontend vikunja-frontend-master.zip
wget https://dl.vikunja.io/frontend/vikunja-frontend-master.zip ```
unzip vikunja-frontend-master.zip -d 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 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 ## Building for release
1. Run the snippet from above, but with a valid frontend version instead of `master` 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` 2. Change the version in `package.json` (That's the one that will be used by electron-builder`
3. `yarn install` 3. `pnpm install`
4. `yarn dist --linux --windows` 4. `pnpm run dist --linux --windows`