You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
kolaente 42bd69321a
Merge remote-tracking branch 'origin/master'
3 years ago
REST-Tests updated todo 3 years ago
docker/etc/services.d Added swaggerfiles do dockerfile 3 years ago
docs added options to configure cache 3 years ago
models /namespaces now also gets lists 3 years ago
public/swagger Renamed list items to tasks 3 years ago
routes Vikunja now uses viper to handle config 3 years ago
vendor added new cache libraries 3 years ago
.drone.yml Added rancher deploy to drone 3 years ago
.gitignore updated gitignore 3 years ago
Dockerfile Added swaggerfiles do dockerfile 3 years ago
Featurecreep.md updated todo 3 years ago
Gopkg.lock added options to configure cache 3 years ago
Gopkg.toml When updating a list task, all relevant values are now updated. 3 years ago
LICENSE initial commit 3 years ago
Makefile updated makefile 3 years ago
README.md Added roadmap 3 years ago
config.yml.sample added options to configure cache 3 years ago
main.go Vikunja now uses viper to handle config 3 years ago

README.md

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 can’t 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.

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