# Project pack: Vikunja @ 5f9061d

Facts about **Vikunja** for an AI following the [BespokeAI handover guide](https://handoff.bespokeai.software/guide/v4.md). Pinned to one version; never changes after publication.

> Vikunja is a to-do app you own. Put tasks into projects, then see them as a simple list, a Kanban board, a table or a timeline. Add due dates, reminders, labels and repeating tasks, and share projects with family or friends. It syncs with phone calendars and can import from Todoist, Trello and Microsoft To Do. It runs on your own computer or server, so your plans stay private.

## Setup path (checked 2026-11-03)
- **Needs Docker.** Tell the person before any setup work; no light non-Docker route is documented upstream. Docker Desktop on Windows may need a computer restart and an admin-only Windows feature (virtualisation); say so and let the person decide.
- Verdict source: https://vikunja.io/docs/
- You may be unable to download source archives or run commands in this session. The person downloads and runs things; if you cannot fetch something, give any changed file in full in chat with its path.

## Version and source
- Repository: https://github.com/go-vikunja/vikunja
- Pinned commit: `5f9061d4bdd1604a05eb3bb7506cecebdfbab917`. Use exactly this version.
- Zip the person can download in a browser: https://github.com/go-vikunja/vikunja/archive/5f9061d4bdd1604a05eb3bb7506cecebdfbab917.zip
- Fresh checkout (only if you have a shell and git): use the commands below in an empty folder. If this exact source is already checked out, keep your branch and use the development command; do not clone again or reset local changes.
- Official docs: https://vikunja.io/docs/
- Live demo: https://try.vikunja.io. Public demo run by the Vikunja team. Register a throwaway account and don't enter anything private.
- Licence: **AGPL-3.0-or-later**. Free to use and change. If you run a changed version that other people use over the internet (not just your own household), you must offer them your source code under the same licence. Private use has no extra obligations. The desktop app folder is GPL-3.0-or-later. A few extra features for organisations (admin panel, time tracking, audit logs, user invites) need a paid licence key; everything else is free.

## Commands from the pinned source
- Developer commands (they may use Docker):

  ```sh
  git clone https://github.com/go-vikunja/vikunja bespoke-vikunja
  cd bespoke-vikunja
  git checkout --detach 5f9061d4bdd1604a05eb3bb7506cecebdfbab917
  # Prepare development requirements and local configuration first.
  # Setup notes: API on :3456; in another terminal: cd frontend && pnpm install && pnpm dev (frontend on :4173)
  mage build && ./vikunja
  ```

- Separate trial of the current upstream release (not your changes; sample data and a separate data directory only):

  ```sh
  docker run -d --name vikunja -p 3456:3456 -e VIKUNJA_SERVICE_PUBLICURL=http://localhost:3456/ -e VIKUNJA_SERVICE_SECRET=change-me-to-a-long-random-string -v vikunja-files:/app/vikunja/files -v vikunja-db:/db vikunja/vikunja # then open http://localhost:3456 and register
  ```
- Tools these commands use: Docker, or for development Go + Mage + Node.js + pnpm
- Develop: `mage build && ./vikunja   # API on :3456; in another terminal: cd frontend && pnpm install && pnpm dev (frontend on :4173)`
- Test: `mage test:web && mage test:feature && (cd frontend && pnpm test:unit)`
- Check/lint: `mage lint && (cd frontend && pnpm lint && pnpm typecheck)`
- Stack: go, typescript, vue, scss (Echo, xorm, Huma, Vue 3, Vite, Pinia, TanStack Query, Bulma). Difficulty for a non-developer with an AI: **moderate**. Registration, reminders, sharing, webhooks, CalDAV and imports are settings. Code changes touch a Go API and a Vue frontend that talks to it through a generated client. Upstream ships detailed AGENTS.md rules and skills.
- The project's own AI instructions, in the repository: `AGENTS.md`, `CLAUDE.md`, `.agents/docs/`, `.agents/skills/`.
Personal data: **yes**. Stored in: SQLite file in the /db volume by default (PostgreSQL or MySQL optional); attachments in /app/vikunja/files. Secrets are entered by the person, never in chat.

---
Later, only when a step needs it: [reference.md](https://handoff.bespokeai.software/p/vikunja/5f9061d/r3/reference.md) (customisation points, must-keep-working, data and costs, coding conventions) · [hosting.md](https://handoff.bespokeai.software/p/vikunja/5f9061d/r3/hosting.md) (long-term hosting; hosts are paid third parties) · [bespoke.yaml](https://handoff.bespokeai.software/p/vikunja/5f9061d/r3/bespoke.yaml) · [SKILL.md](https://handoff.bespokeai.software/p/vikunja/5f9061d/r3/SKILL.md)