Go to file
kolaente 42bd69321a
Merge remote-tracking branch 'origin/master'
2018-09-17 07:48:03 +02:00
REST-Tests updated todo 2018-09-12 22:59:45 +02:00
docker/etc/services.d Added swaggerfiles do dockerfile 2018-09-08 16:54:21 +02:00
docs added options to configure cache 2018-09-13 19:53:03 +02:00
models /namespaces now also gets lists 2018-09-17 07:27:49 +02:00
public/swagger Renamed list items to tasks 2018-08-30 08:09:17 +02:00
routes Vikunja now uses viper to handle config 2018-09-08 13:29:35 +02:00
vendor added new cache libraries 2018-09-13 19:53:39 +02:00
.drone.yml Added rancher deploy to drone 2018-09-10 19:24:17 +02:00
.gitignore updated gitignore 2018-09-13 19:30:22 +02:00
Dockerfile Added swaggerfiles do dockerfile 2018-09-08 16:54:21 +02:00
Featurecreep.md updated todo 2018-09-17 07:30:23 +02:00
Gopkg.lock added options to configure cache 2018-09-13 19:53:03 +02:00
Gopkg.toml When updating a list task, all relevant values are now updated. 2018-09-10 19:34:34 +02:00
LICENSE initial commit 2018-06-10 11:11:42 +02:00
Makefile updated makefile 2018-09-15 16:11:28 +02:00
README.md Added roadmap 2018-07-25 21:47:26 +02:00
config.yml.sample added options to configure cache 2018-09-13 19:53:03 +02:00
main.go Vikunja now uses viper to handle config 2018-09-08 13:29:35 +02:00


Vikunja API

The Todo-app to organize your life.

Build Status License: LGPL v3 Download


  • Create TODO lists with tasks
    • Reminder for tasks
  • Namespaces: A "group" which bundels multiple lists
  • Share lists and namespaces with teams with granular permissions


  • Labels for todo lists and tasks

  • Prioritize tasks

  • More sharing features

    • Share with individual users
    • Share via a world-readable link with or without password, like Nextcloud
  • Mobile apps (seperate repo)

  • Webapp (seperate repo)

  • "Native" clients (will probably be something with electron)


To contribute to Vikunja, fork the project and work on the master branch.

Some internal packages are referenced using their respective package URL. This can become problematic. To “trick” the Go tool into thinking this is a clone from the official repository, download the source code into $GOPATH/code.vikunja.io/api. Fork the Vikunja repository, it should then be possible to switch the source directory on the command line.

cd $GOPATH/src/code.vikunja.io/api

To be able to create pull requests, the forked repository should be added as a remote to the Vikunja sources, otherwise changes cant be pushed.

git remote rename origin upstream
git remote add origin git@git.kolaente.de:<USERNAME>/vikunja.git
git fetch --all --prune

This should provide a working development environment for Vikunja. Take a look at the Makefile to get an overview about the available tasks. The most common tasks should be make test which will start our test environment and make build which will build a vikunja binary into the working directory. Writing test cases is not mandatory to contribute, but it is highly encouraged and helps developers sleep at night.

Thats it! You are ready to hack on Vikunja. Test changes, push them to the repository, and open a pull request.