vikunja-api/README.md

3.4 KiB

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

Vikunja API

The Todo-app to organize your life.

Table of contents

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
  • Plenty of details for tasks

See the features page on our website for a more exaustive list or try it on try.vikunja.io!

Docs

All docs can be found on the vikunja home page.

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
  • Get all your tasks for an interval (day/month/period)
  • Labels for tasks
  • Assign users to tasks
  • Attachments on tasks
  • More sharing features
    • Share with individual users
    • Share via a world-readable link with or without password, like Nextcloud
  • SSE 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 our roadmap (hosted on Vikunja!) for even more!

Contributing

Fork -> Push -> Pull-Request. Also see the dev docs for more infos.

License

This project is licensed under the GPLv3 License. See the LICENSE file for the full license text.