The to-do app to organize your life. Public API Roadmap here: https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth?view=64
Go to file
konrad c51ca4dd26
All checks were successful
the build was successful
Fixed dockerfile (#11)
2018-11-02 09:18:38 +00:00
docker/etc/services.d Added swaggerfiles do dockerfile 2018-09-08 16:54:21 +02:00
docs Prevent login from inactive (aka non-verified) users (#8) 2018-11-01 22:47:41 +00:00
pkg Fix checking for an email verification token (#10) 2018-11-01 22:59:20 +00:00
public/swagger Add password reset (#3) 2018-10-27 09:33:28 +00:00
REST-Tests Fix checking for an email verification token (#10) 2018-11-01 22:59:20 +00:00
templates/mail Add user email verification when registering (#5) 2018-10-27 13:14:55 +00:00
vendor Fix build when using go modules (#6) 2018-10-28 16:11:13 +00:00
.drone.yml Fix build when using go modules (#6) 2018-10-28 16:11:13 +00:00
.gitignore updated gitignore 2018-09-13 19:30:22 +02:00
config.yml.sample Add password reset (#3) 2018-10-27 09:33:28 +00:00
Dockerfile Fixed dockerfile (#11) 2018-11-02 09:18:38 +00:00
Featurecreep.md Add user email verification when registering (#5) 2018-10-27 13:14:55 +00:00
go.mod Fix build when using go modules (#6) 2018-10-28 16:11:13 +00:00
go.sum Fix build when using go modules (#6) 2018-10-28 16:11:13 +00:00
LICENSE initial commit 2018-06-10 11:11:42 +02:00
main.go New structure (#7) 2018-10-31 12:42:38 +00:00
Makefile Fix build when using go modules (#6) 2018-10-28 16:11:13 +00:00
README.md Fix build when using go modules (#6) 2018-10-28 16:11:13 +00:00
tools.go Fix build when using go modules (#6) 2018-10-28 16:11:13 +00:00

Vikunja API

The Todo-app to organize your life.

Build Status License: LGPL v3 Download Docker Pulls Swagger Docs Go Report Card

Features

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

Try it under try.vikunja.io!

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

We use go modules to vendor libraries for Vikunja, so you'll need at least go 1.11.

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>/api.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.