File: README.md Copy Chapter

Vikunja

The task manager you actually own.

If Vikunja is useful to you, please consider supporting the project. You can buy a coffee, sponsor on GitHub or buy a sticker pack.
We're also offering a hosted version of Vikunja if you want a hassle-free solution for yourself or your team.
If you or your company needs admin panel, audit logs or time tracking, check out Vikunja Pro.

[!NOTE]
For the development of Vikunja, we're using LLM-Assisted coding tools in various parts of the codebase.
Most contributions made @tink-bot are built that way.

Table of contents Copy Chapter

• Security Reports
• Features
• Docs
  • Roadmap
• Contributing
• License
  • Unsplash Images

Security Reports Copy Chapter

If you find any security-related issues you don't want to disclose publicly, please use the contact information on our website.

Features Copy Chapter

See the features page on our website for a more exhaustive list or
try it on try.vikunja.io!

Docs Copy Chapter

• Installing
• Build from source
• Development setup
• Magefile
• Testing

All docs can be found on the Vikunja home page.

Roadmap Copy Section

See the roadmap (hosted on Vikunja!) for more!

Contributing Copy Chapter

Please check out the contribution guidelines on the website.

License Copy Chapter

Most of this repository is licensed under AGPL‑3.0‑or‑later.
The contents of desktop/ are licensed under
GPL‑3.0‑or‑later.

Unsplash Images Copy Section

Background images from Unsplash are distributed under the Unsplash License. The license requires giving credit to the photographer and Unsplash. See Unsplash’s terms for more information.

File: desktop/README.md Copy Chapter

Vikunja desktop

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

Dev Copy Chapter

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 Copy Chapter

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 Copy Chapter

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