vikunja-api/README.md

81 lines
3.4 KiB
Markdown
Raw Normal View History

2019-02-17 20:53:04 +01:00
<img src="https://vikunja.io/images/vikunja-logo.svg" alt="" style="display: block;width: 50%;margin: 0 auto;" width="50%"/>
2018-07-25 21:47:26 +02:00
2019-01-11 23:46:51 +01:00
[![Build Status](https://drone1.kolaente.de/api/badges/vikunja/api/status.svg)](https://drone1.kolaente.de/vikunja/api)
2018-11-26 21:17:33 +01:00
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE)
2020-07-07 10:48:49 +02:00
[![Download](https://img.shields.io/badge/download-v0.14.1-brightgreen.svg)](https://dl.vikunja.io)
2018-09-20 21:59:43 +02:00
[![Docker Pulls](https://img.shields.io/docker/pulls/vikunja/api.svg)](https://hub.docker.com/r/vikunja/api/)
2019-02-17 20:57:28 +01:00
[![Swagger Docs](https://img.shields.io/badge/swagger-docs-brightgreen.svg)](https://try.vikunja.io/api/v1/docs)
2018-11-17 00:29:10 +01:00
[![Go Report Card](https://goreportcard.com/badge/git.kolaente.de/vikunja/api)](https://goreportcard.com/report/git.kolaente.de/vikunja/api)
2019-02-17 20:53:04 +01:00
# Vikunja API
> The Todo-app to organize your life.
# Table of contents
* [Features](#features)
* [Docs](#docs)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
2018-07-25 21:47:26 +02:00
## Features
* Create TODO lists with tasks
* Reminder for tasks
* Namespaces: A "group" which bundels multiple lists
2018-09-18 18:20:39 +02:00
* Share lists and namespaces with teams and users with granular permissions
2019-09-01 11:01:36 +02:00
* Plenty of details for tasks
2018-09-18 18:20:39 +02:00
2019-09-01 11:01:36 +02:00
See [the features page](https://vikunja.io/en/features/) on our website for a more exaustive list or
try it on [try.vikunja.io](https://try.vikunja.io)!
2019-02-17 20:53:04 +01:00
## Docs
2019-02-17 20:57:28 +01:00
* [Installing](https://vikunja.io/docs/installing/)
* [Build from source](https://vikunja.io/docs/build-from-sources/)
* [Development setup](https://vikunja.io/docs/development/)
* [Makefile](https://vikunja.io/docs/makefile/)
* [Testing](https://vikunja.io/docs/testing/)
All docs can be found on [the vikunja home page](https://vikunja.io/docs/).
2018-07-25 21:47:26 +02:00
### Roadmap
2018-11-17 00:29:10 +01:00
> 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.
2018-12-02 01:49:30 +01:00
* [x] Prioritize tasks
2018-12-01 03:00:57 +01:00
* [x] Subtasks
2018-12-01 00:28:01 +01:00
* [x] Repeating tasks
2018-11-17 00:29:10 +01:00
* [x] Get tasks via caldav
2018-12-25 21:29:16 +01:00
* [x] Get all your tasks for an interval (day/month/period)
2018-12-31 02:21:44 +01:00
* [x] Labels for tasks
* [x] Assign users to tasks
* [x] Attachments on tasks
* [x] More sharing features
2018-12-01 00:28:01 +01:00
* [x] Share with individual users
2019-09-01 11:01:36 +02:00
* [x] Share via a world-readable link with or without password, like Nextcloud
2020-01-19 22:27:19 +01:00
* [x] Disable registration, making an instance "invite-only"
2019-09-01 11:01:36 +02:00
* [ ] SSE to notify multiple clients of updates when something was changed
2018-12-25 21:29:16 +01:00
* [ ] "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
See [our roadmap](https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth) (hosted on Vikunja!) for even more!
2018-12-25 21:29:16 +01:00
* [ ] [Mobile apps](https://code.vikunja.io/app) (seperate repo) *In Progress*
* [ ] [Webapp](https://code.vikunja.io/frontend) (seperate repo) *In Progress*
2018-07-25 21:47:26 +02:00
2019-02-17 20:53:04 +01:00
## Contributing
2018-07-25 21:47:26 +02:00
2019-02-17 20:57:28 +01:00
Fork -> Push -> Pull-Request. Also see the [dev docs](https://vikunja.io/docs/development/) for more infos.
2018-07-25 21:47:26 +02:00
2019-02-17 20:53:04 +01:00
## License
2018-07-25 21:47:26 +02:00
2019-04-05 16:54:41 +02:00
This project is licensed under the GPLv3 License. See the [LICENSE](LICENSE) file for the full license text.