Roadmap · Website · Docs · Discord
- 👁️ 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 (coming soon) : Save time with reusable board templates
- ⚡️ Integrations (coming soon) : Connect your favourite tools
See our roadmap for upcoming features.
- Clone the repository (or fork)
git clone https://github.com/kanbn/kan.git
- Install dependencies
pnpm install
- Copy
.env.example
to.env
and configure your environment variables - Migrate database
pnpm db:migrate
- Start the development server
pnpm dev
Variable | Description | Required | Example |
---|---|---|---|
POSTGRES_URL |
PostgreSQL connection URL | Yes | postgres://user:pass@localhost:5432/db |
EMAIL_FROM |
Sender email address | Yes | "Kan <hello@mail.kan.bn>" |
SMTP_HOST |
SMTP server hostname | Yes | smtp.resend.com |
SMTP_PORT |
SMTP server port | Yes | 465 |
SMTP_USER |
SMTP username/email | Yes | resend |
SMTP_PASSWORD |
SMTP password/token | Yes | re_xxxx |
NEXT_PUBLIC_BASE_URL |
Base URL of your installation | Yes | http://localhost:3000 |
BETTER_AUTH_SECRET |
Auth encryption secret | Yes | Random 32+ char string |
BETTER_AUTH_URL |
Auth callback URL | Yes | Same as NEXT_PUBLIC_BASE_URL |
BETTER_AUTH_TRUSTED_ORIGINS |
Allowed callback origins | For Google login | http://localhost:3000,http://localhost:3001 |
GOOGLE_CLIENT_ID |
Google OAuth client ID | For Google login | xxx.apps.googleusercontent.com |
GOOGLE_CLIENT_SECRET |
Google OAuth client secret | For Google login | xxx |
DISCORD_CLIENT_ID |
Discord OAuth client ID | For Discord login | xxx |
DISCORD_CLIENT_SECRET |
Discord OAuth client secret | For Discord login | xxx |
GITHUB_CLIENT_ID |
GitHub OAuth client ID | For GitHub login | xxx |
GITHUB_CLIENT_SECRET |
GitHub OAuth client secret | For GitHub login | xxx |
S3_REGION |
S3 storage region | For file uploads | WEUR |
S3_ENDPOINT |
S3 endpoint URL | For file uploads | https://xxx.r2.cloudflarestorage.com |
S3_ACCESS_KEY_ID |
S3 access key | For file uploads | xxx |
S3_SECRET_ACCESS_KEY |
S3 secret key | For file uploads | xxx |
NEXT_PUBLIC_STORAGE_URL |
Storage service URL | For file uploads | https://storage.kanbn.com |
NEXT_PUBLIC_STORAGE_DOMAIN |
Storage domain name | For file uploads | kanbn.com |
NEXT_PUBLIC_AVATAR_BUCKET_NAME |
S3 bucket name for avatars | For file uploads | avatars |
See .env.example
for a complete list of supported environment variables.
We welcome contributions! Please read our contribution guidelines before submitting a pull request.
Kan is licensed under the AGPLv3 license.
For support or to get in touch, please email henry@kan.bn or join our Discord server.