[![Build Status](https://drone1.kolaente.de/api/badges/vikunja/api/status.svg)](https://drone1.kolaente.de/vikunja/api) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE) [![Download](https://img.shields.io/badge/download-v0.5-brightgreen.svg)](https://storage.kolaente.de/minio/vikunja/) [![Docker Pulls](https://img.shields.io/docker/pulls/vikunja/api.svg)](https://hub.docker.com/r/vikunja/api/) [![Swagger Docs](https://img.shields.io/badge/swagger-docs-brightgreen.svg)](https://try.vikunja.io/api/v1/swagger) [![Go Report Card](https://goreportcard.com/badge/git.kolaente.de/vikunja/api)](https://goreportcard.com/report/git.kolaente.de/vikunja/api) [![cover.run](https://cover.run/go/code.vikunja.io/api.svg?style=flat&tag=golang-1.10)](https://cover.run/go?tag=golang-1.10&repo=code.vikunja.io%2Fapi) # Vikunja API > The Todo-app to organize your life. # Table of contents * [Features](#features) * [Docs](#docs) * [Roadmap](#roadmap) * [Contributing](#contributing) * [License](#license) ## 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 on [try.vikunja.io](https://try.vikunja.io)! ## Docs * [Build from source](docs/setup/build-from-source.md) * [Development setup](docs/development-setup.md) * [Makefile](docs/development/make.md) * [Testing](docs/development/test.md) ### 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. * [x] Prioritize tasks * [x] Subtasks * [x] Repeating tasks * [x] Get tasks via caldav * [x] Get all your tasks for an interval (day/month/period) * [x] Labels for tasks * [x] Assign users to tasks * [ ] Attachments on tasks * [ ] More sharing features * [x] Share with individual users * [ ] Share via a world-readable link with or without password, like Nextcloud * [ ] Read-only websocket to notify multiple clients of updates when something was changed * [ ] "Smart Lists" - Create lists based on filters * [ ] IMAP-Integration - Send an email to Vikunja to create a new task * [ ] Webhooks - Trigger other events when an action is done (like completing a task) * [ ] Performace statistics - Get an overview and beautiful charts about what you got done this month * [ ] Activity feeds - Get a quick overview about who did what * [ ] Bulk-edit multiple tasks at once * [ ] Team-efforts - Requiring a task to be marked as done by multiple members until it's done * [ ] Global limits for namespaces/lists/tasks * [ ] Disable registration, making an instance "invite-only" See [Featurecreep.md](Featurecreep.md) for even more! (mostly ideas, for now) * [ ] [Mobile apps](https://code.vikunja.io/app) (seperate repo) *In Progress* * [ ] [Webapp](https://code.vikunja.io/frontend) (seperate repo) *In Progress* ## Contributing Fork -> Push -> Pull-Request. Also see the [dev docs](docs/development-setup.md) for more infos. ## License This project is licensed under the GPLv3 License. See the [LICENSE](LICENSE) file for the full license text.