tasks/README.md
sunjam 12d0a2e65c
Update README.md
updated per PR notes
2019-10-10 09:10:19 -07:00

46 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Tasks
![Downloads](https://img.shields.io/github/downloads/nextcloud/tasks/total.svg) [![Build Status](https://scrutinizer-ci.com/g/nextcloud/tasks/badges/build.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/tasks/build-status/master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nextcloud/tasks/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/tasks/?branch=master) [![Code coverage](https://img.shields.io/codecov/c/github/nextcloud/tasks.svg)](https://codecov.io/gh/nextcloud/tasks/) [![Dependabot status](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg?longCache=true&logo=dependabot)](https://dependabot.com)
**A tasks app for [Nextcloud](http://nextcloud.com). Easily sync tasks from various devices with your Nextcloud and edit them online.**
![tasks](https://raw.githubusercontent.com/nextcloud/tasks/master/screenshots/tasks-1.png)
## Features
* add and delete tasks, edit their title, description, start and due dates, set their priority and status
* support for subtasks
* smart collections showing you your important, current and upcoming tasks
* simply drag and drop tasks to other calendars or make them subtasks
## Installation
In your Nextcloud, simply navigate to »Apps«, choose the category »Organization«, find the Tasks app and enable it.
Then open the Tasks app from the app menu.
## Apps which sync with Nextcloud Tasks (using CalDAV)
* Apple Reminders (iOS, MacOS)
* [2Do](https://www.2doapp.com/) (Android, iOS, MacOS)
* [Davx5](https://www.davx5.com/) (Android)
* [OpenTasks](https://opentasks.app/) [(Android)](https://play.google.com/store/apps/details?id=org.dmfs.tasks)
* [Outlook Caldav Synchronizer](https://caldavsynchronizer.org/) (Windows)
* [Tasks: Astrid Todo List Clone](https://tasks.org/) [(Android)](https://play.google.com/store/apps/details?id=org.tasks&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1)
* [Qownnotes](https://www.qownnotes.org/) (Read-only, Cross Platform Desktop App)
* [Thunderbird Lightning Plugin](https://addons.thunderbird.net/en-US/thunderbird/addon/lightning/) (Cross Platform Desktop App)
* [Vdirsyncer](https://vdirsyncer.pimutils.org/en/stable/) (Linux)
## Maintainers
[Raimund Schlüßler](https://github.com/raimund-schluessler) [and many more](https://github.com/nextcloud/tasks/graphs/contributors)
If youd like to join, just go through the [issue list](https://github.com/nextcloud/tasks/issues?q=is%3Aopen+is%3Aissue+label%3A%22starter+issue%22) and fix some. :)
## Developer setup info
Just clone this repo into your apps directory (Nextcloud server installation needed). Additionally, [nodejs and npm](https://nodejs.org/en/download/package-manager/) are needed for installing JavaScript dependencies.
Once node and npm are installed, PHP and JavaScript dependencies can be installed by running
```bash
$ make
```
Please execute this command with your ordinary user account and neither root nor sudo.