Reading the repo

Opening the box…

Assembly instructions

plankanban/planka

Elegant open source project tracking. Self-hosted Kanban for teams — free Community edition, with PLANKA Pro for organisations.

Node.js#collaboration#docker#kanban#project-management

Difficulty: Moderate
Time: about 15 min
Stars: ★ 12,665
Activity: Updated this month
License: Not detected
Open issues: 363
Got it running: Be the first
Looked up: 5 h ago

Saved setup from 5 h ago

Start here

Website ↗planka.appThe project's own site.Docs ↗docs.planka.cloudLinked from the README.

Will it work on my device?

Yes, it runs on macOS

You'll build it yourself with Node.js.
It also needs PostgreSQL running (Docker handles this).

Checking for

6 steps on macOS

Clone the repository

Needs Git: xcode-select --install

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

Install the required runtimes

Node.js 24

# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm)
nvm install 24

3
Start backing services
Needs: PostgreSQL
```
brew install --cask docker  # Docker Desktop
docker compose -f docker-compose.yml up -d
```
If you see Cannot connect to the Docker daemon: start Docker Desktop (or the Docker service) first.
4
Install dependencies
```
npm ci
```
5
Run it
```
npm run start
```
6
Run the tests
```
npm test
```

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 12 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js 24runtime
1×npm package manager
1×PostgreSQL service

3× settings in .env

BASE_URL
DATABASE_URL
SECRET_KEYsecret

Share this manual

Good to know

Dockerfile available (base image: node:24-alpine).
Nested projects: client/package.json, server/package.json, server/requirements.txt

package.json scripts (25)

client:buildnpm run build --prefix client
client:lintnpm run lint --prefix client
client:locales:checknpm run locales:check --prefix client
client:startnpm start --prefix client
client:testnpm test --prefix client
docker:builddocker build -t planka .
gvnpm i --package-lock-only --ignore-scripts && genversion --source . --template server/version-template.ejs server/version.js && genversion --source . --template client/version-template.ejs client/src/version.js
postinstallnpm i --prefix server && npm i --prefix client
lintnpm run server:lint && npm run client:lint
preparehusky
server:buildnpm run build --prefix server
server:consolenpm run console --prefix server
server:db:clean-orphaned-recordsnpm run db:clean-orphaned-records --prefix server
server:db:create-admin-usernpm run db:create-admin-user --prefix server
server:db:initnpm run db:init --prefix server
server:db:migratenpm run db:migrate --prefix server
server:db:seednpm run db:seed --prefix server
server:db:upgradenpm run db:upgrade --prefix server
server:lintnpm run lint --prefix server
server:startnpm start --prefix server
server:start:prodnpm run start:prod --prefix server
server:swagger:generatenpm run swagger:generate --prefix server
server:testnpm test --prefix server
startconcurrently -n server,client "npm run server:start" "npm run client:start"
testnpm run server:test && npm run client:test

Files we read (12)

.github/workflows/build-and-publish-release-package.yml

.github/workflows/build-and-push-docker-image.yml

.github/workflows/build-and-push-docker-nightly-image.yml

.github/workflows/build-and-test.yml

.github/workflows/lint.yml

.github/workflows/release-helm-chart.yml

CONTRIBUTING.md

Dockerfile

README.md

docker-compose.yml

package.json

server/.env.sample

Branch master · 1,648 files in the repo

Opening the box…

Start here

Yes, it runs on macOS

6 steps on macOS

Clone the repository

Install the required runtimes

Start backing services

Install dependencies

Run it

Run the tests

Did you get it running?

Still stuck? Get a written guide