The to-do app to organize your life. Public API Roadmap here: https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth?view=64
konrad e882fbe6ad
Some checks failed
the build failed
Added dockerfile
2018-09-08 15:08:33 +02:00
docs [skip-ci] updated docs 2018-09-08 13:50:05 +02:00
models Fixed lint 2018-09-08 13:31:13 +02:00
public/swagger Renamed list items to tasks 2018-08-30 08:09:17 +02:00
REST-Tests List rights are now respected 2018-09-06 08:42:18 +02:00
routes Vikunja now uses viper to handle config 2018-09-08 13:29:35 +02:00
vendor updated deps 2018-09-08 13:50:18 +02:00
.drone.yml Added dockerfile 2018-09-08 15:08:33 +02:00
.gitignore Vikunja now uses viper to handle config 2018-09-08 13:29:35 +02:00
config.yml.sample [skip-ci] updated docs 2018-09-08 13:50:05 +02:00
Dockerfile Added dockerfile 2018-09-08 15:08:33 +02:00
Featurecreep.md Fixed CORS once and for all 2018-09-07 22:49:16 +02:00
Gopkg.lock Updated deps 2018-09-08 13:36:22 +02:00
Gopkg.toml Updated deps 2018-09-08 13:36:22 +02:00
LICENSE initial commit 2018-06-10 11:11:42 +02:00
main.go Vikunja now uses viper to handle config 2018-09-08 13:29:35 +02:00
Makefile Added tests for team members 2018-07-27 19:20:49 +02:00
README.md Added roadmap 2018-07-25 21:47:26 +02:00

Vikunja API

The Todo-app to organize your life.

Build Status License: LGPL v3 Download

Features

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

Roadmap

  • 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)

Development

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.