Compare commits

...

11 Commits

Author SHA1 Message Date
Henry
808d23bd15 fix: add google to the remote patterns 2025-06-05 12:58:01 +01:00
Lonneke Vuur
1b2389d618 fix: issue 23, handle external URLs in avatar rendering 2025-06-05 10:28:26 +02:00
LovelessCodes
c9a9779e79 feat: include column name in board repository query response to use in board PageHead (#20) 2025-06-05 06:08:20 +01:00
LovelessCodes
356e35964b feat: allow public card access without authentication (#19) 2025-06-05 06:05:03 +01:00
Henry
1698b744e4 chore: fix labels on issue templates 2025-06-05 05:41:21 +01:00
Henry
27c0c0a5e8 chore: update issue templates 2025-06-05 05:37:31 +01:00
Henry
2129a60d22 chore: setup github issue templates 2025-06-05 05:22:22 +01:00
Henry
84dd9a9b6d feat: support SMTP via nodemailer (#17) 2025-06-04 12:33:24 +01:00
Henry
3625d702e3 fix: bypass custom URL checkout for self hosted (#16)
* fix: bypass custom URL checkout for self hosted

* Update error code
2025-06-04 07:34:19 +01:00
Sergio Guillen
2047f5a9ea Add step to run db:migrate as it is a required step to have a functional local setup (#14) 2025-06-04 06:04:18 +01:00
Henry
fcb97908e0 fix: revert to GH token 2025-06-03 23:12:04 +01:00
27 changed files with 198 additions and 60 deletions

View File

@@ -1,8 +1,10 @@
POSTGRES_URL=
EMAIL_FROM=
EMAIL_URL=
EMAIL_TOKEN=
SMTP_HOST=
SMTP_PORT=
SMTP_USER=
SMTP_PASSWORD=
NEXT_PUBLIC_BASE_URL=
NEXT_PUBLIC_STORAGE_URL=

37
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,37 @@
---
name: "\U0001F41B Bug Report"
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
## 🐛 Bug Report
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Environment (please complete the following information):**
- OS: [e.g. macOS, Windows, Linux]
- Browser [e.g. chrome, safari]
- Node version [e.g. 20]
- App version/commit [if applicable]
**Additional context**
Add any other context about the problem here.

View File

@@ -0,0 +1,30 @@
---
name: "✨ Feature Request"
about: Suggest an idea for this project
title: ''
labels: feature
assignees: ''
---
## ✨ Feature Request
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
**Implementation ideas (optional)**
If you have any ideas about how this feature could be implemented, please share them here.
**Would you like to work on this feature?**
- [ ] Yes, I'd like to help implement this feature
- [ ] No, I'm just suggesting the feature

View File

@@ -57,7 +57,7 @@ jobs:
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.KAN_PAT }}
password: ${{ secrets.GITHUB_TOKEN }}
# Extract metadata (tags, labels) for Docker
# https://github.com/docker/metadata-action

View File

@@ -60,7 +60,13 @@ pnpm install
```
3. Copy `.env.example` to `.env` and configure your environment variables
4. Start the development server
4. Migrate database
```bash
pnpm db:migrate
```
5. Start the development server
```bash
pnpm dev
@@ -72,8 +78,10 @@ pnpm dev
| -------------------------------- | ----------------------------- | ---------------- | --------------------------------------------- |
| `POSTGRES_URL` | PostgreSQL connection URL | Yes | `postgres://user:pass@localhost:5432/db` |
| `EMAIL_FROM` | Sender email address | Yes | `"Kan <hello@mail.kan.bn>"` |
| `EMAIL_URL` | Email service API URL | Yes | `https://api.resend.com/emails` |
| `EMAIL_TOKEN` | Email service API token | Yes | `re_xxxx` |
| `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` |
@@ -85,7 +93,7 @@ pnpm dev
| `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 | `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.

View File

@@ -26,7 +26,16 @@ const config = {
typescript: { ignoreBuildErrors: true },
images: {
domains: [env("NEXT_PUBLIC_STORAGE_DOMAIN") ?? ""],
remotePatterns: [
{
protocol: "https",
hostname: `*.${env("NEXT_PUBLIC_STORAGE_DOMAIN")}`,
},
{
protocol: "https",
hostname: "*.googleusercontent.com",
},
],
},
experimental: {
instrumentationHook: true,

View File

@@ -1,8 +1 @@
window.__ENV = {
NEXT_PUBLIC_UMAMI_ID: "aaed1f55-25e2-4223-b918-e429c390be35",
NEXT_PUBLIC_KAN_ENV: "cloud",
NEXT_PUBLIC_BASE_URL: "http://localhost:3000",
NEXT_PUBLIC_AVATAR_BUCKET_NAME: "avatars",
NEXT_PUBLIC_STORAGE_DOMAIN: "storage.kanbn.com",
NEXT_PUBLIC_STORAGE_URL: "https://storage.kanbn.com",
};
window.__ENV = {"NEXT_PUBLIC_UMAMI_ID":"aaed1f55-25e2-4223-b918-e429c390be35","NEXT_PUBLIC_KAN_ENV":"cloud","NEXT_PUBLIC_BASE_URL":"http://localhost:3000","NEXT_PUBLIC_AVATAR_BUCKET_NAME":"avatars","NEXT_PUBLIC_STORAGE_DOMAIN":"kanbn.com","NEXT_PUBLIC_STORAGE_URL":"https://storage.kanbn.com"};

View File

@@ -4,7 +4,7 @@ import { useForm } from "react-hook-form";
import { FaGoogle } from "react-icons/fa";
import { z } from "zod";
import { authClient } from "@kan/auth";
import { authClient } from "@kan/auth/client";
import Button from "~/components/Button";
import Input from "~/components/Input";

View File

@@ -3,7 +3,7 @@ import { useRouter } from "next/navigation";
import { Menu, Transition } from "@headlessui/react";
import { Fragment } from "react";
import { authClient } from "@kan/auth";
import { authClient } from "@kan/auth/client";
import { useTheme } from "~/providers/theme";
import { getAvatarUrl } from "~/utils/helpers";

View File

@@ -1,6 +1,6 @@
import { toNodeHandler } from "better-auth/node";
import { initAuth } from "@kan/auth";
import { initAuth } from "@kan/auth/server";
import { createDrizzleClient } from "@kan/db/client";
export const config = { api: { bodyParser: false } };

View File

@@ -45,6 +45,10 @@ export const formatMemberDisplayName = (
return localPart.replace(/[_-]/g, ".");
};
export const getAvatarUrl = (key: string) => {
return `${env("NEXT_PUBLIC_STORAGE_URL")}/${env("NEXT_PUBLIC_AVATAR_BUCKET_NAME")}/${key}`;
export const getAvatarUrl = (imageOrKey: string) => {
if (imageOrKey.startsWith("http://") || imageOrKey.startsWith("https://")) {
return imageOrKey;
}
return `${env("NEXT_PUBLIC_STORAGE_URL")}/${env("NEXT_PUBLIC_AVATAR_BUCKET_NAME")}/${imageOrKey}`;
};

View File

@@ -1,4 +1,4 @@
import { authClient } from "@kan/auth";
import { authClient } from "@kan/auth/client";
import Button from "~/components/Button";
import Input from "~/components/Input";

View File

@@ -1,4 +1,5 @@
import { zodResolver } from "@hookform/resolvers/zod";
import { env } from "next-runtime-env";
import { useForm } from "react-hook-form";
import { HiCheck, HiMiniStar } from "react-icons/hi2";
import { z } from "zod";
@@ -92,7 +93,9 @@ const UpdateWorkspaceUrlForm = ({
const isWorkspaceSlugAvailable = checkWorkspaceSlugAvailability.data;
const onSubmit = (data: FormValues) => {
if (isWorkspaceSlugAvailable?.isAvailable && workspacePlan !== "pro")
if (!isWorkspaceSlugAvailable?.isAvailable) return;
if (workspacePlan !== "pro" && env("NEXT_PUBLIC_KAN_ENV") === "cloud")
return openModal("UPDATE_WORKSPACE_URL", data.slug);
updateWorkspaceSlug.mutate({
@@ -118,7 +121,11 @@ const UpdateWorkspaceUrlForm = ({
? "This workspace username has already been taken"
: undefined)
}
prefix="kan.bn/"
prefix={
env("NEXT_PUBLIC_KAN_ENV") === "cloud"
? "kan.bn/"
: `${env("NEXT_PUBLIC_BASE_URL")}/`
}
iconRight={
isWorkspaceSlugAvailable?.isAvailable ||
(workspacePlan === "pro" && slug === workspaceUrl) ? (

View File

@@ -578,14 +578,6 @@ export const cardRouter = createTRPCRouter({
>(),
)
.query(async ({ ctx, input }) => {
const userId = ctx.user?.id;
if (!userId)
throw new TRPCError({
message: `User not authenticated`,
code: "UNAUTHORIZED",
});
const card = await cardRepo.getWorkspaceAndCardIdByCardPublicId(
ctx.db,
input.cardPublicId,
@@ -597,7 +589,17 @@ export const cardRouter = createTRPCRouter({
code: "NOT_FOUND",
});
await assertUserInWorkspace(ctx.db, userId, card.workspaceId);
if (card.workspaceVisibility === "private") {
const userId = ctx.user?.id;
if (!userId)
throw new TRPCError({
message: `User not authenticated`,
code: "UNAUTHORIZED",
});
await assertUserInWorkspace(ctx.db, userId, card.workspaceId);
}
const result = await cardRepo.getWithListAndMembersByPublicId(
ctx.db,

View File

@@ -1,7 +1,7 @@
import { TRPCError } from "@trpc/server";
import { z } from "zod";
import { authClient } from "@kan/auth";
import { authClient } from "@kan/auth/client";
import * as memberRepo from "@kan/db/repository/member.repo";
import * as userRepo from "@kan/db/repository/user.repo";
import * as workspaceRepo from "@kan/db/repository/workspace.repo";

View File

@@ -1,4 +1,5 @@
import { TRPCError } from "@trpc/server";
import { env } from "next-runtime-env";
import { z } from "zod";
import * as workspaceRepo from "@kan/db/repository/workspace.repo";
@@ -224,10 +225,19 @@ export const workspaceRouter = createTRPCRouter({
const isWorkspaceSlugAvailable =
await workspaceRepo.isWorkspaceSlugAvailable(ctx.db, input.slug);
if (
env("NEXT_PUBLIC_KAN_ENV") === "cloud" &&
workspace.plan !== "pro" &&
input.slug !== workspace.publicId
) {
throw new TRPCError({
message: `Workspace slug cannot be changed in cloud without upgrading to a paid plan`,
code: "FORBIDDEN",
});
}
if (
reservedOrPremiumWorkspaceSlug?.type === "reserved" ||
(workspace.plan !== "pro" &&
reservedOrPremiumWorkspaceSlug?.type === "premium") ||
!isWorkspaceSlugAvailable
) {
throw new TRPCError({

View File

@@ -6,7 +6,7 @@ import superjson from "superjson";
import { ZodError } from "zod";
import type { dbClient } from "@kan/db/client";
import { initAuth } from "@kan/auth";
import { initAuth } from "@kan/auth/server";
import { createDrizzleClient } from "@kan/db/client";
export interface User {

View File

@@ -4,7 +4,15 @@
"version": "0.1.0",
"type": "module",
"exports": {
".": "./src/index.ts"
".": "./src/index.ts",
"./client": {
"types": "./src/client.ts",
"default": "./src/client.ts"
},
"./server": {
"types": "./src/server.ts",
"default": "./src/server.ts"
}
},
"license": "GPL-3.0",
"scripts": {

View File

@@ -1,6 +1 @@
import { initAuth } from "./auth";
import { authClient } from "./clients";
export const name = "auth";
export { initAuth, authClient };

View File

@@ -0,0 +1 @@
export { initAuth } from "./auth";

View File

@@ -239,6 +239,7 @@ export const getBySlug = async (
workspace: {
columns: {
publicId: true,
name: true,
slug: true,
},
},

View File

@@ -731,6 +731,7 @@ export const getWorkspaceAndCardIdByCardPublicId = async (
board: {
columns: {
workspaceId: true,
visibility: true,
},
},
},
@@ -742,6 +743,7 @@ export const getWorkspaceAndCardIdByCardPublicId = async (
? {
id: result.id,
workspaceId: result.list.board.workspaceId,
workspaceVisibility: result.list.board.visibility,
}
: null;
};

View File

@@ -24,12 +24,14 @@
},
"dependencies": {
"@react-email/components": "^0.0.25",
"nodemailer": "^7.0.3",
"react-email": "^3.0.1"
},
"devDependencies": {
"@kan/eslint-config": "workspace:*",
"@kan/prettier-config": "workspace:*",
"@kan/tsconfig": "workspace:*",
"@types/nodemailer": "^6.4.17",
"eslint": "catalog:",
"prettier": "catalog:",
"typescript": "catalog:"

View File

@@ -1,4 +1,5 @@
import { render } from "@react-email/render";
import nodemailer from "nodemailer";
import JoinWorkspaceTemplate from "./templates/join-workspace";
import MagicLinkTemplate from "./templates/magic-link";
@@ -10,6 +11,16 @@ const emailTemplates: Record<Templates, React.FC> = {
JOIN_WORKSPACE: JoinWorkspaceTemplate,
};
const transporter = nodemailer.createTransport({
host: process.env.SMTP_HOST,
port: Number(process.env.SMTP_PORT),
secure: true,
auth: {
user: process.env.SMTP_USER,
pass: process.env.SMTP_PASSWORD,
},
});
export const sendEmail = async (
to: string,
subject: string,
@@ -20,22 +31,17 @@ export const sendEmail = async (
const html = await render(<EmailTemplate {...data} />, { pretty: true });
const response = await fetch(process.env.EMAIL_URL!, {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${process.env.EMAIL_TOKEN}`,
},
body: JSON.stringify({
from: process.env.EMAIL_FROM,
to,
subject,
html,
}),
});
const options = {
from: process.env.EMAIL_FROM,
to,
subject,
html,
};
if (!response.ok) {
throw new Error(`Failed to send email: ${response.statusText}`);
const response = await transporter.sendMail(options);
if (!response.accepted.length) {
throw new Error(`Failed to send email: ${response.response}`);
}
return response;

19
pnpm-lock.yaml generated
View File

@@ -370,6 +370,9 @@ importers:
'@react-email/components':
specifier: ^0.0.25
version: 0.0.25(react-dom@18.3.1(react@18.3.1))(react@18.3.1)
nodemailer:
specifier: ^7.0.3
version: 7.0.3
react-email:
specifier: ^3.0.1
version: 3.0.4(bufferutil@4.0.8)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(utf-8-validate@6.0.3)
@@ -383,6 +386,9 @@ importers:
'@kan/tsconfig':
specifier: workspace:*
version: link:../../tooling/typescript
'@types/nodemailer':
specifier: ^6.4.17
version: 6.4.17
eslint:
specifier: 'catalog:'
version: 9.16.0(jiti@1.21.6)
@@ -2342,6 +2348,9 @@ packages:
'@types/node@20.17.9':
resolution: {integrity: sha512-0JOXkRyLanfGPE2QRCwgxhzlBAvaRdCNMcvbd7jFfpmD4eEXll7LRwy5ymJmyeZqk7Nh7eD2LeUyQ68BbndmXw==}
'@types/nodemailer@6.4.17':
resolution: {integrity: sha512-I9CCaIp6DTldEg7vyUTZi8+9Vo0hi1/T8gv3C89yk1rSAAzoKQ8H8ki/jBYJSFoH/BisgLP8tkZMlQ91CIquww==}
'@types/pg@8.11.6':
resolution: {integrity: sha512-/2WmmBXHLsfRqzfHW7BNZ8SbYzE8OSk7i3WjFYvfgRHj7S1xj+16Je5fUKv3lVdVzk/zn9TXOqf+avFCFIE0yQ==}
@@ -4537,6 +4546,10 @@ packages:
node-releases@2.0.19:
resolution: {integrity: sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw==}
nodemailer@7.0.3:
resolution: {integrity: sha512-Ajq6Sz1x7cIK3pN6KesGTah+1gnwMnx5gKl3piQlQQE/PwyJ4Mbc8is2psWYxK3RJTVeqsDaCv8ZzXLCDHMTZw==}
engines: {node: '>=6.0.0'}
nopt@7.2.1:
resolution: {integrity: sha512-taM24ViiimT/XntxbPyJQzCG+p4EKOpgD3mxFwW38mGjVUrfERQOeY4EDHjdnptttfHuHQXFx+lTP08Q+mLa/w==}
engines: {node: ^14.17.0 || ^16.13.0 || >=18.0.0}
@@ -8095,6 +8108,10 @@ snapshots:
dependencies:
undici-types: 6.19.8
'@types/nodemailer@6.4.17':
dependencies:
'@types/node': 20.17.9
'@types/pg@8.11.6':
dependencies:
'@types/node': 20.17.9
@@ -10759,6 +10776,8 @@ snapshots:
node-releases@2.0.19: {}
nodemailer@7.0.3: {}
nopt@7.2.1:
dependencies:
abbrev: 2.0.0

View File

@@ -50,8 +50,10 @@
"GOOGLE_CLIENT_ID",
"GOOGLE_CLIENT_SECRET",
"EMAIL_FROM",
"EMAIL_URL",
"EMAIL_TOKEN",
"SMTP_HOST",
"SMTP_PORT",
"SMTP_USER",
"SMTP_PASSWORD",
"NEXT_PUBLIC_KAN_ENV",
"STRIPE_SECRET_KEY",
"STRIPE_WEBHOOK_SECRET",