diff --git a/desktop/README.md b/desktop/README.md index 98336b8aa..048dddbe5 100644 --- a/desktop/README.md +++ b/desktop/README.md @@ -1,27 +1,40 @@ # 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) -[![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! ## 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: -```bash -rm -rf frontend vikunja-frontend-master.zip -wget https://dl.vikunja.io/frontend/vikunja-frontend-master.zip -unzip vikunja-frontend-master.zip -d frontend +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 `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` -3. `yarn install` -4. `yarn dist --linux --windows` - +3. `pnpm install` +4. `pnpm run dist --linux --windows`