The to-do app to organize your life. Public API Roadmap here: https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth?view=kanban
Go to file
konrad cc6b35e314
the build was successful Details
Priorites for tasks (#31)
2018-12-02 00:49:30 +00:00
REST-Tests Priorites for tasks (#31) 2018-12-02 00:49:30 +00:00
docker/etc/services.d Added swaggerfiles do dockerfile 2018-09-08 16:54:21 +02:00
docs Priorites for tasks (#31) 2018-12-02 00:49:30 +00:00
pkg Priorites for tasks (#31) 2018-12-02 00:49:30 +00:00
public/swagger Change License to GPLv3 (#26) 2018-11-26 20:17:33 +00:00
templates/mail Add user email verification when registering (#5) 2018-10-27 13:14:55 +00:00
vendor Fixed generation of swagger docs (#29) 2018-12-01 01:59:17 +00:00
.drone.yml remove drone github update step 2018-11-28 22:53:55 +01:00
.gitignore Move the crudhandler to own repo (#27) 2018-11-30 23:26:56 +00:00
Dockerfile Fix docker build 2018-11-25 22:00:43 +01:00
Featurecreep.md Priorites for tasks (#31) 2018-12-02 00:49:30 +00:00
LICENSE Change License to GPLv3 (#26) 2018-11-26 20:17:33 +00:00
Makefile Migrate to new swagger docs generation (#18) 2018-11-12 15:46:35 +00:00
README.md Priorites for tasks (#31) 2018-12-02 00:49:30 +00:00
config.yml.sample Added pagination (#16) 2018-11-09 10:30:17 +00:00
go.mod Fixed generation of swagger docs (#29) 2018-12-01 01:59:17 +00:00
go.sum Fixed generation of swagger docs (#29) 2018-12-01 01:59:17 +00:00
main.go Change License to GPLv3 (#26) 2018-11-26 20:17:33 +00:00
tools.go Change License to GPLv3 (#26) 2018-11-26 20:17:33 +00:00

README.md

Vikunja API

The Todo-app to organize your life.

Build Status License: GPL 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

I know, it's still a long way to go. I'm currently working on a lot of "basic" features, the exiting things will come later. Don't worry, they'll come.

  • Prioritize tasks

  • Subtasks

  • Repeating tasks

  • Get tasks via caldav

  • Labels for todo lists and tasks

  • Assign users to tasks

  • Attachments on tasks

  • Get all your tasks for an interval (day/month/period)

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

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.