github.com/kanbn/kan @v0.6.0 sqlite

Kan

The open-source project management alternative to Trello.

Roadmap · Website · Docs · Discord

Features 💫

• 👁️ Board Visibility: Control who can view and edit your boards
• 🤝 Workspace Members: Invite members and collaborate with your team
• 🚀 Trello Imports: Easily import your Trello boards
• 🔍 Labels & Filters: Organise and find cards quickly
• 💬 Comments: Discuss and collaborate with your team
• 📝 Activity Log: Track all card changes with detailed activity history
• 🎨 Templates : Save time with reusable custom board templates
• ⚡️ Integrations (coming soon) : Connect your favourite tools

See our roadmap for upcoming features.

Screenshot 👁️

Made With 🛠️

• Next.js
• tRPC
• Better Auth
• Tailwind CSS
• Drizzle ORM
• React Email

Self Hosting 🐳

One-click Deployments

The easiest way to deploy Kan is through Railway. We've partnered with Railway to maintain an official template that supports the development of the project.

Docker Compose

Alternatively, you can self-host Kan with Docker Compose. This will set up everything for you including your postgres database and automatically run migrations.

1. Create a .env file with your environment variables (see Environment Variables section below)

2. Use the provided docker-compose.yml file or create your own with the following configuration:

services:
  migrate:
    image: ghcr.io/kanbn/kan-migrate:latest
    container_name: kan-migrate
    networks:
      - kan-network
    environment:
      - POSTGRES_URL=${POSTGRES_URL}
    depends_on:
      postgres:
        condition: service_healthy
    restart: "no"

  web:
    image: ghcr.io/kanbn/kan:latest
    container_name: kan-web
    ports:
      - "${WEB_PORT:-3000}:3000"
    networks:
      - kan-network
    env_file:
      - .env
    environment:
      - NEXT_PUBLIC_BASE_URL=${NEXT_PUBLIC_BASE_URL}
      - BETTER_AUTH_SECRET=${BETTER_AUTH_SECRET}
      - POSTGRES_URL=${POSTGRES_URL}
      - NEXT_PUBLIC_ALLOW_CREDENTIALS=true
    depends_on:
      migrate:
        condition: service_completed_successfully
    restart: unless-stopped

  postgres:
    image: postgres:15
    container_name: kan-db
    environment:
      - POSTGRES_DB=kan_db
      - POSTGRES_USER=kan
      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
    ports:
      - 5432:5432
    volumes:
      - kan_postgres_data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U kan -d kan_db"]
      interval: 5s
      timeout: 5s
      retries: 10
    restart: unless-stopped
    networks:
      - kan-network

networks:
  kan-network:

volumes:
  kan_postgres_data:

1. Start the containers in detached mode:

docker compose up -d

The migrate service will automatically run database migrations before the web service starts. The application will be available at http://localhost:3000 (or the port specified in WEB_PORT).

Managing containers:

• To stop the containers: docker compose down
• To view logs: docker compose logs -f
• To view logs for a specific service: docker compose logs -f web or docker compose logs -f migrate
• To restart the containers: docker compose restart
• To rebuild after code changes: docker compose up -d --build

For the complete Docker Compose configuration with all optional features, see docker-compose.yml in the repository.

Local Development 🧑‍💻

1. Clone the repository (or fork)

git clone https://github.com/kanbn/kan.git

1. Install dependencies

pnpm install

1. Copy .env.example to .env and configure your environment variables
2. Migrate database

pnpm db:migrate

1. Start the development server

pnpm dev

Environment Variables 🔐