planka/README.md

Planka

A Trello-like kanban board built with React and Redux.

Client demo (without server features).

Features

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

Deploy

Please note that Planka is NOT released yet, API and database structure may be changed!

Docker Compose

• Make sure you have Docker and Docker Compose installed and operational.
• Create docker-compose.yml based on the example. 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.

Download the docker-compose.yml:

curl -L https://raw.githubusercontent.com/plankanban/planka/master/docker-compose.yml -o docker-compose.yml

Pull images and start services:

docker-compose up -d

Demo user: demo@demo.demo demo

Development

Clone the repository and install dependencies:

git clone https://github.com/plankanban/planka.git

cd planka
npm install

Create a database and edit DATABASE_URL in .env file. Then initialize it:

npm run server:db:init

Start the development server:

npm start

Demo user: demo@demo.demo demo

Tech stack

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

Roadmap

• File attachments
• Member permissions
• Fetch last data after reconnection
• Custom fields
• Public boards
• Automatic actions

License

Planka is MIT licensed.