2019-02-17 19:53:04 +00:00
|
|
|
<img src="https://vikunja.io/images/vikunja-logo.svg" alt="" style="display: block;width: 50%;margin: 0 auto;" width="50%"/>
|
2018-07-25 19:47:26 +00:00
|
|
|
|
2020-11-20 20:54:15 +00:00
|
|
|
[](https://drone.kolaente.de/vikunja/api)
|
2020-12-23 15:41:52 +00:00
|
|
|
[](LICENSE)
|
2021-01-10 15:09:26 +00:00
|
|
|
[](https://dl.vikunja.io)
|
2018-09-20 19:59:43 +00:00
|
|
|
[](https://hub.docker.com/r/vikunja/api/)
|
2019-02-17 19:57:28 +00:00
|
|
|
[](https://try.vikunja.io/api/v1/docs)
|
2018-11-16 23:29:10 +00:00
|
|
|
[](https://goreportcard.com/report/git.kolaente.de/vikunja/api)
|
|
|
|
|
|
2019-02-17 19:53:04 +00: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 19:47:26 +00:00
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
* Create TODO lists with tasks
|
|
|
|
|
* Reminder for tasks
|
|
|
|
|
* Namespaces: A "group" which bundels multiple lists
|
2018-09-18 16:20:39 +00:00
|
|
|
* Share lists and namespaces with teams and users with granular permissions
|
2019-09-01 09:01:36 +00:00
|
|
|
* Plenty of details for tasks
|
2018-09-18 16:20:39 +00:00
|
|
|
|
2019-09-01 09:01:36 +00: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 19:53:04 +00:00
|
|
|
|
|
|
|
|
## Docs
|
|
|
|
|
|
2019-02-17 19:57:28 +00:00
|
|
|
* [Installing](https://vikunja.io/docs/installing/)
|
|
|
|
|
* [Build from source](https://vikunja.io/docs/build-from-sources/)
|
|
|
|
|
* [Development setup](https://vikunja.io/docs/development/)
|
2020-09-03 15:34:44 +00:00
|
|
|
* [Magefile](https://vikunja.io/docs/mage/)
|
2019-02-17 19:57:28 +00:00
|
|
|
* [Testing](https://vikunja.io/docs/testing/)
|
|
|
|
|
|
|
|
|
|
All docs can be found on [the vikunja home page](https://vikunja.io/docs/).
|
2018-07-25 19:47:26 +00:00
|
|
|
|
|
|
|
|
### Roadmap
|
|
|
|
|
|
2021-01-10 15:09:26 +00:00
|
|
|
See [the roadmap](https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth) (hosted on Vikunja!) for more!
|
2018-12-25 20:29:16 +00: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 19:47:26 +00:00
|
|
|
|
2019-02-17 19:53:04 +00:00
|
|
|
## Contributing
|
2018-07-25 19:47:26 +00:00
|
|
|
|
2019-02-17 19:57:28 +00:00
|
|
|
Fork -> Push -> Pull-Request. Also see the [dev docs](https://vikunja.io/docs/development/) for more infos.
|
2018-07-25 19:47:26 +00:00
|
|
|
|
2019-02-17 19:53:04 +00:00
|
|
|
## License
|
2018-07-25 19:47:26 +00:00
|
|
|
|
2021-01-10 15:09:26 +00:00
|
|
|
This project is licensed under the AGPLv3 License. See the [LICENSE](LICENSE) file for the full license text.
|
|
|
|
|
|
