Docker/planka
Docker/planka
1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-07-18 20:59:44 +02:00
Code Issues Releases Activity
Élégant suivi de projets open source https://planka.app
105 commits 2 branches 41 tags 48 MiB
Find a file
Maksim Eltyshev 4fb6b5f156 Update readme
2020-10-17 23:49:19 +05:00
.github Create FUNDING.yml 2020-10-06 21:12:14 +05:00
client Update dependencies 2020-09-28 04:40:10 +05:00
server Update dependencies 2020-09-28 04:40:10 +05:00
.dockerignore Docker, update readme, update dependencies 2019-10-01 04:18:33 +05:00
.gitattributes Fix repository language 2020-05-29 21:46:08 +05:00
.gitignore Add start script for Docker image, pre-commit lint check, package.json scripts cleanup 2020-04-24 21:44:54 +05:00
CODE_OF_CONDUCT.md Update repository paths because of transfer 2020-04-23 22:56:25 +05:00
demo.gif Docker, update readme, update dependencies 2019-10-01 04:18:33 +05:00
docker-compose-dev.yml Update dependencies 2020-05-06 21:21:18 +05:00
docker-compose.yml Fix Docker volumes 2020-05-26 01:32:11 +05:00
docker-start.sh Add start script for Docker image, pre-commit lint check, package.json scripts cleanup 2020-04-24 21:44:54 +05:00
Dockerfile Fix Docker volumes 2020-05-26 01:32:11 +05:00
LICENSE Initial commit 2019-08-31 04:07:25 +05:00
package-lock.json Update dependencies 2020-09-28 04:40:10 +05:00
package.json Update dependencies 2020-09-28 04:40:10 +05:00
README.md Update readme 2020-10-17 23:49:19 +05:00

README.md

Planka

David (path) Docker Cloud Build Status GitHub

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

Client demo (without server features).

Buy Me a Coffee at ko-fi.com

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

Roadmap

Current task

Projects should have Managers who have the ability to create/edit/delete boards. Boards should have their own Members, so members won't see all boards, just those they belong to. Planka will be released after this breaking change.

Future tasks

  • Fetch last data after reconnection
  • Custom fields
  • Public boards
  • Automatic actions

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

Either use a local database or start the provided development database:

docker-compose -f docker-compose-dev.yml up

Edit DATABASE_URL in .env file if needed, then initialize the database:

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

License

Planka is MIT licensed.