1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-07-18 12:49:43 +02:00

Update readme

This commit is contained in:
Maksim Eltyshev 2020-10-06 21:07:14 +05:00
parent 71388fbc5f
commit a4d24c7eff

View file

@ -6,9 +6,9 @@ A Trello-like kanban board built with React and Redux.
![](https://raw.githubusercontent.com/plankanban/planka/master/demo.gif)
<a href="https://plankanban.github.io/planka" target="_blank">**Client demo**</a> (without server features).
[**Client demo**](https://plankanban.github.io/planka) (without server features).
<a href="https://ko-fi.com/meltyshev" target="_blank"><img src="https://cdn.ko-fi.com/cdn/kofi3.png?v=2" alt="Buy Me a Coffee at ko-fi.com" border="0" height="36" style="border:0px;height:36px;" /></a>
<a href="https://ko-fi.com/meltyshev" target="_blank"><img src="https://cdn.ko-fi.com/cdn/kofi4.png?v=2" alt="Buy Me a Coffee at ko-fi.com" border="0" height="36" style="border:0px;height:36px;" /></a>
## Features
@ -27,10 +27,10 @@ A Trello-like kanban board built with React and Redux.
### Docker Compose
<a href="https://hub.docker.com/r/meltyshev/planka" target="_blank"><img src="https://d207aa93qlcgug.cloudfront.net/1.95.5.qa/img/nav/docker-logo-loggedout.png" /></a>
[![](https://d207aa93qlcgug.cloudfront.net/1.95.5.qa/img/nav/docker-logo-loggedout.png)](https://hub.docker.com/r/meltyshev/planka)
- Make sure you have <a href="https://docs.docker.com/get-docker/" target="_blank">Docker</a> and <a href="https://docs.docker.com/compose/install/" target="_blank">Docker Compose</a> installed and operational.
- Create `docker-compose.yml` based on <a href="https://raw.githubusercontent.com/plankanban/planka/master/docker-compose.yml" target="_blank">the example</a>. This is the ONLY file you will need. You can create this file on your own machine by copy and pasting the content.
- Make sure you have [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed and operational.
- Create `docker-compose.yml` based on [the example](https://raw.githubusercontent.com/plankanban/planka/master/docker-compose.yml). This is the ONLY file you will need. You can create this file on your own machine by copy and pasting the content.
- Edit `BASE_URL` to match your domain name or IP address.
- Edit `SECRET_KEY` with random value. You can generate it by `openssl rand -hex 64`.
@ -96,4 +96,4 @@ Demo user: demo@demo.demo demo
## License
Planka is <a href="https://github.com/plankanban/planka/blob/master/LICENSE" target="_blank">MIT licensed</a>.
Planka is [MIT licensed](https://github.com/plankanban/planka/blob/master/LICENSE).