planka_ynh/README.md

<!--
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand.
-->

# Planka for YunoHost

[![Integration level](https://dash.yunohost.org/integration/planka.svg)](https://dash.yunohost.org/appci/app/planka) ![Working status](https://ci-apps.yunohost.org/ci/badges/planka.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/planka.maintain.svg)

[![Install Planka with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=planka)

*[Read this README in other languages.](./ALL_README.md)*

> *This package allows you to install Planka quickly and simply on a YunoHost server.*  
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*

## Overview

Elegant open source project tracking.

### Features

- Create projects, boards, lists, cards, labels and tasks
- Add card members, track time, set a due date, add attachments, write comments
- Markdown support in a card description and comment
- Filter by members and labels
- Customize project background
- Real-time updates
- User notifications
- Internationalization


**Shipped version:** 1.18.1~ynh1

**Demo:** <https://plankanban.github.io/planka/#/>

## Screenshots

![Screenshot of Planka](./doc/screenshots/screenshot.png)

## Documentation and resources

- Official app website: <https://planka.app/>
- Official admin documentation: <https://docs.planka.cloud/docs/intro/>
- Upstream app code repository: <https://github.com/plankanban/planka>
- YunoHost Store: <https://apps.yunohost.org/app/planka>
- Report a bug: <https://github.com/YunoHost-Apps/planka_ynh/issues>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/planka_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/planka_ynh/tree/testing --debug
or
sudo yunohost app upgrade planka -u https://github.com/YunoHost-Apps/planka_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>