The to-do app to organize your life. Public API Roadmap here: https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth?view=kanban
Go to file
kolaente 206705d2e9
the build was successful Details
updated makefile to use new golint url
2018-10-15 12:54:39 +02:00
REST-Tests Replaced CObject with a function returning an object 2018-10-11 17:53:59 +02:00
docker/etc/services.d Added swaggerfiles do dockerfile 2018-09-08 16:54:21 +02:00
docs Added config for database max connections 2018-10-11 18:39:53 +02:00
models Added config for database max connections 2018-10-11 18:39:53 +02:00
public/swagger updated swagger spec 2018-10-03 19:30:43 +02:00
routes Fixed not setting http code on error 2018-10-11 18:18:44 +02:00
vendor Added logging 2018-09-19 08:35:53 +02:00
.drone.yml Added new checks (#2) 2018-09-23 19:15:14 +00: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-10-06 15:08:38 +02:00
Gopkg.lock Added logging 2018-09-19 08:35:53 +02:00
Gopkg.toml Added logging 2018-09-19 08:35:53 +02:00
LICENSE initial commit 2018-06-10 11:11:42 +02:00
Makefile updated makefile to use new golint url 2018-10-15 12:54:39 +02:00
README.md added go report badge 2018-09-23 21:16:56 +02:00
config.yml.sample added options to configure cache 2018-09-13 19:53:03 +02:00
go.mod added go mod 2018-10-11 13:28:41 +02:00
go.sum added go mod 2018-10-11 13:28:41 +02:00
main.go Added logging 2018-09-19 08:35:53 +02:00

README.md

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

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.