api/README.md

62 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

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 21:47:26 +02:00
2020-11-20 21:54:15 +01:00
[![Build Status](https://drone.kolaente.de/api/badges/vikunja/api/status.svg)](https://drone.kolaente.de/vikunja/api)
2020-12-23 16:41:52 +01:00
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE)
2021-09-08 19:46:02 +02:00
[![Download](https://img.shields.io/badge/download-v0.18.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)
[![Go Report Card](https://goreportcard.com/badge/kolaente.dev/vikunja/api)](https://goreportcard.com/report/kolaente.dev/vikunja/api)
2018-11-17 00:29:10 +01:00
2019-02-17 19:53:04 +00:00
# Vikunja API
> The Todo-app to organize your life.
# Table of contents
2021-04-22 15:07:28 +02:00
* [Security Reports](#security-reports)
2019-02-17 19:53:04 +00:00
* [Features](#features)
* [Docs](#docs)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
2021-04-22 15:07:28 +02:00
## Security Reports
If you find any security-related issues you don't want to disclose publicly, please use [the contact information on our website](https://vikunja.io/contact/#security).
2018-07-25 21:47:26 +02:00
## Features
* Create TODO lists with tasks
* Reminder for tasks
* Namespaces: A "group" which bundles 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 19:53:04 +00: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/)
* [Magefile](https://vikunja.io/docs/magefile/)
2019-02-17 20:57:28 +01:00
* [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
2021-01-10 16:09:26 +01:00
See [the roadmap](https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth) (hosted on Vikunja!) for more!
2018-12-25 21:29:16 +01:00
* [ ] [Mobile apps](https://code.vikunja.io/app) (separate repo) *In Progress*
* [ ] [Webapp](https://code.vikunja.io/frontend) (separate repo) *In Progress*
2018-07-25 21:47:26 +02:00
2019-02-17 19:53:04 +00:00
## Contributing
2018-07-25 21:47:26 +02:00
Fork -> Push -> Pull-Request. Also see the [dev docs](https://vikunja.io/docs/development/) for more info.
2018-07-25 21:47:26 +02:00
2019-02-17 19:53:04 +00:00
## License
2018-07-25 21:47:26 +02:00
2021-01-10 16:09:26 +01:00
This project is licensed under the AGPLv3 License. See the [LICENSE](LICENSE) file for the full license text.