planka/README.md

# Planka
#### Elegant open source project tracking.

![David (path)](https://img.shields.io/github/package-json/v/plankanban/planka) ![Docker Pulls](https://img.shields.io/badge/docker_pulls-4M%2B-%23066da5) ![GitHub](https://img.shields.io/github/license/plankanban/planka)

![](https://raw.githubusercontent.com/plankanban/planka/master/demo.gif)

[**Client demo**](https://plankanban.github.io/planka) (without server features).

## Features

- Create projects, boards, lists, cards, labels and tasks
- Add card members, track time, set due dates, add attachments, write comments
- Markdown support in card description and comments
- Filter by members and labels
- Customize project backgrounds
- Real-time updates
- Internal notifications
- Multiple interface languages
- Single sign-on via OpenID Connect

## How to deploy Planka

There are many ways to install Planka, [check them out](https://docs.planka.cloud/docs/intro).

For configuration, please see the [configuration section](https://docs.planka.cloud/docs/category/configuration).

## Mobile app

Here is the [mobile app repository](https://github.com/LouisHDev/planka_app) maintained by the community, where you can build an app for iOS and Android.

Alternatively, you can download the [Android APK](https://github.com/LouisHDev/planka_app/releases/latest/download/app-release.apk) directly.

## Contact

- If you want to get a hosted version of Planka, you can contact us via email contact@planka.cloud
- For any security issues, please do not create a public issue on GitHub, instead please write to security@planka.cloud

We do NOT offer any public support via email, please use GitHub.

## Development

See the [development section](https://docs.planka.cloud/docs/Development).

## Tech stack

- React, Redux, Redux-Saga, Redux-ORM, Semantic UI React, react-beautiful-dnd
- Sails.js, Knex.js
- PostgreSQL

## License

Planka is [AGPL-3.0 licensed](https://github.com/plankanban/planka/blob/master/LICENSE).

## Contributors

[![](https://contrib.rocks/image?repo=plankanban/planka)](https://github.com/plankanban/planka/graphs/contributors)
Initial commit 2019-08-31 04:07:25 +05:00			`# Planka`
docs: Little readme fixes 2023-12-10 22:20:23 +01:00			`#### Elegant open source project tracking.`
Initial commit 2019-08-31 04:07:25 +05:00
docs: Update docker pulls counter 2024-07-16 12:39:57 +02:00			`![David (path)](https://img.shields.io/github/package-json/v/plankanban/planka) ![Docker Pulls](https://img.shields.io/badge/docker_pulls-4M%2B-%23066da5) ![GitHub](https://img.shields.io/github/license/plankanban/planka)`
Add secret key to environment variables, update readme 2019-10-04 04:19:46 +05:00
Update repository paths because of transfer 2020-04-23 22:56:25 +05:00			`![](https://raw.githubusercontent.com/plankanban/planka/master/demo.gif)`
Initial commit 2019-08-31 04:07:25 +05:00
Update readme 2020-10-06 21:07:14 +05:00			`[Client demo](https://plankanban.github.io/planka) (without server features).`
Update readme 2020-10-06 21:04:43 +05:00
Docker, update readme, update dependencies 2019-10-01 04:18:33 +05:00			`## Features`
Initial commit 2019-08-31 04:07:25 +05:00
			`- Create projects, boards, lists, cards, labels and tasks`
docs: Update features, add contributors 2024-03-13 11:02:52 +01:00			`- Add card members, track time, set due dates, add attachments, write comments`
			`- Markdown support in card description and comments`
Initial commit 2019-08-31 04:07:25 +05:00			`- Filter by members and labels`
docs: Update features, add contributors 2024-03-13 11:02:52 +01:00			`- Customize project backgrounds`
Add client demo 2019-09-04 22:25:24 +05:00			`- Real-time updates`
docs: Update features, add contributors 2024-03-13 11:02:52 +01:00			`- Internal notifications`
			`- Multiple interface languages`
			`- Single sign-on via OpenID Connect`
Initial commit 2019-08-31 04:07:25 +05:00
docs: Update information, links to documentation 2023-02-20 23:36:52 +01:00			`## How to deploy Planka`
Initial commit 2019-08-31 04:07:25 +05:00
docs: Little readme fixes 2023-12-10 22:20:23 +01:00			`There are many ways to install Planka, [check them out](https://docs.planka.cloud/docs/intro).`
Meta: Add missing return 2023-09-23 03:48:32 +02:00
docs: Update information, links to documentation 2023-02-20 23:36:52 +01:00			`For configuration, please see the [configuration section](https://docs.planka.cloud/docs/category/configuration).`
feat: Modify logger to log to file that supports fail2ban (#284) 2022-08-22 18:42:56 -04:00
docs: Add information about mobile app 2024-10-03 19:07:59 +02:00			`## Mobile app`

			`Here is the [mobile app repository](https://github.com/LouisHDev/planka_app) maintained by the community, where you can build an app for iOS and Android.`

			`Alternatively, you can download the [Android APK](https://github.com/LouisHDev/planka_app/releases/latest/download/app-release.apk) directly.`

docs: Update information, links to documentation 2023-02-20 23:36:52 +01:00			`## Contact`
feat: Modify logger to log to file that supports fail2ban (#284) 2022-08-22 18:42:56 -04:00
docs: Update information, links to documentation 2023-02-20 23:36:52 +01:00			`- If you want to get a hosted version of Planka, you can contact us via email contact@planka.cloud`
			`- For any security issues, please do not create a public issue on GitHub, instead please write to security@planka.cloud`
feat: Modify logger to log to file that supports fail2ban (#284) 2022-08-22 18:42:56 -04:00
docs: Update information, links to documentation 2023-02-20 23:36:52 +01:00			`We do NOT offer any public support via email, please use GitHub.`
feat: Add manual backup and restore scripts for docker (#386) Closes #128 2023-01-17 20:16:50 +01:00
Docker, update readme, update dependencies 2019-10-01 04:18:33 +05:00			`## Development`
Initial commit 2019-08-31 04:07:25 +05:00
docs: Update information, links to documentation 2023-02-20 23:36:52 +01:00			`See the [development section](https://docs.planka.cloud/docs/Development).`
Initial commit 2019-08-31 04:07:25 +05:00
Docker, update readme, update dependencies 2019-10-01 04:18:33 +05:00			`## Tech stack`
Initial commit 2019-08-31 04:07:25 +05:00
Docker, update readme, update dependencies 2019-10-01 04:18:33 +05:00			`- React, Redux, Redux-Saga, Redux-ORM, Semantic UI React, react-beautiful-dnd`
			`- Sails.js, Knex.js`
			`- PostgreSQL`
Initial commit 2019-08-31 04:07:25 +05:00
			`## License`

meta: Change license to AGPL-3.0 2023-01-16 23:22:00 +01:00			`Planka is [AGPL-3.0 licensed](https://github.com/plankanban/planka/blob/master/LICENSE).`
docs: Update features, add contributors 2024-03-13 11:02:52 +01:00
			`## Contributors`

			`[![](https://contrib.rocks/image?repo=plankanban/planka)](https://github.com/plankanban/planka/graphs/contributors)`