Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

docs: add railway docs

Andrej Acevski9636b719631e
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index c6e9f107a..9e9afd32c 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -12,6 +12,6 @@ jobs:
- name: Setup Biome
uses: biomejs/setup-biome@v2
with:
- version: 2.0.6
+ version: 2.3.10
- name: Run Biome
run: biome ci .
diff --git a/apps/docs/components/ai/page-actions.tsx b/apps/docs/components/ai/page-actions.tsx
index 01e538f3a..d63eb7b65 100644
--- a/apps/docs/components/ai/page-actions.tsx
+++ b/apps/docs/components/ai/page-actions.tsx
@@ -11,11 +11,13 @@ import {
Check,
ChevronDown,
Copy,
+ ExternalLink,
ExternalLinkIcon,
MessageCircleIcon,
} from "lucide-react";
import { useMemo, useState } from "react";
import { cn } from "@/lib/utils";
+import { Button } from "../ui/button";
const cache = new Map<string, string>();
@@ -69,6 +71,32 @@ export function LLMCopyButton({
);
}
+export function DeployButton({
+ href,
+ children,
+}: {
+ href: string;
+ children: React.ReactNode;
+}) {
+ return (
+ <button
+ type="button"
+ onClick={() => window.open(href, "_blank")}
+ className={cn(
+ buttonVariants({
+ color: "secondary",
+ size: "sm",
+ className:
+ "gap-2 [&_svg]:size-3.5 [&_svg]:text-fd-muted-foreground h-[30px] mt-2",
+ }),
+ )}
+ >
+ <ExternalLink />
+ {children}
+ </button>
+ );
+}
+
const optionVariants = cva(
"text-sm p-2 rounded-lg inline-flex items-center gap-2 hover:text-fd-accent-foreground hover:bg-fd-accent [&_svg]:size-4",
);
diff --git a/apps/docs/content/docs/core/deployments/meta.json b/apps/docs/content/docs/core/deployments/meta.json
new file mode 100644
index 000000000..21e3fd8ea
--- /dev/null
+++ b/apps/docs/content/docs/core/deployments/meta.json
@@ -0,0 +1,6 @@
+{
+ "title": "Deployments",
+ "icon": "Cloud",
+ "pages": ["railway"],
+ "defaultOpen": false
+}
diff --git a/apps/docs/content/docs/core/deployments/railway.mdx b/apps/docs/content/docs/core/deployments/railway.mdx
new file mode 100644
index 000000000..fb6a11934
--- /dev/null
+++ b/apps/docs/content/docs/core/deployments/railway.mdx
@@ -0,0 +1,77 @@
+---
+title: Railway
+description: Deploy Kaneo to Railway using the official template.
+---
+import { DeployButton } from "@/components/ai/page-actions";
+
+## Railway Template
+
+Kaneo provides an official Railway template for easy deployment with a single click.
+
+<DeployButton href="https://railway.com/deploy/kaneo">
+ Deploy on Railway
+</DeployButton>
+
+## What the Template Includes
+
+The Railway template automatically configures:
+
+- **PostgreSQL Database**: Managed PostgreSQL instance
+- **API Service**: Pre-configured Hono API server
+- **Web Service**: Pre-configured React web application
+- **Environment Variables**: All required variables with sensible defaults
+- **Networking**: Proper service discovery and internal communication
+- **Build Configuration**: Optimized Docker builds for both services
+
+## Deployment Steps
+
+1. **Click the Deploy Button** above to open the Railway template
+2. **Connect to Railway** (sign up or log in if needed)
+3. **Configure Environment Variables**:
+ - Set your `AUTH_SECRET` (minimum 32 characters)
+ - Review other environment variables as needed
+4. **Deploy** - Railway will build and deploy all services automatically
+
+## Post-Deployment Setup
+
+After deployment completes:
+
+1. **Access Your Application**: Railway will provide URLs for both services
+2. **Create Admin Account**: Visit the web application to create your first user
+3. **Configure Domain** (optional): Add custom domains in Railway dashboard
+4. **Set Up SSO** (optional): Configure GitHub, Google, or other providers
+
+## Environment Variables
+
+The template includes these pre-configured variables:
+
+```
+# Railway automatically sets these
+DATABASE_URL=postgresql://postgres:password@host:port/database
+KANEO_API_URL=https://your-api.railway.app
+KANEO_CLIENT_URL=https://your-web.railway.app
+
+# You may want to customize these
+AUTH_SECRET=your-32-character-secret-here
+CORS_ORIGINS=https://your-web.railway.app
+```
+
+## Monitoring and Scaling
+
+Railway provides built-in:
+
+- **Health Checks**: Automatic service monitoring
+- **Logs**: Centralized logging for all services
+- **Metrics**: Performance and usage analytics
+- **Scaling**: Easy horizontal scaling when needed
+
+## Troubleshooting
+
+If you encounter issues:
+
+1. **Check Logs**: Use Railway's log viewer to debug
+2. **Verify Environment**: Ensure all required variables are set
+3. **Redeploy**: Sometimes a fresh deployment resolves issues
+4. **Check Resource Usage**: Free tier has limitations
+
+For more detailed troubleshooting, see the [troubleshooting section](/docs/core/installation/start-services).
\ No newline at end of file
diff --git a/apps/docs/next-env.d.ts b/apps/docs/next-env.d.ts
index c4b7818fb..9edff1c7c 100644
--- a/apps/docs/next-env.d.ts
+++ b/apps/docs/next-env.d.ts
@@ -1,6 +1,6 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />
-import "./.next/dev/types/routes.d.ts";
+import "./.next/types/routes.d.ts";
// NOTE: This file should not be edited
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
diff --git a/apps/web/src/components/ui/breadcrumb.tsx b/apps/web/src/components/ui/breadcrumb.tsx
index 74feb915f..f36747421 100644
--- a/apps/web/src/components/ui/breadcrumb.tsx
+++ b/apps/web/src/components/ui/breadcrumb.tsx
@@ -53,10 +53,9 @@ function BreadcrumbPage({ className, ...props }: React.ComponentProps<"span">) {
return (
<span
data-slot="breadcrumb-page"
- role="link"
+ role="presentation"
aria-disabled="true"
aria-current="page"
- tabIndex={0}
className={cn("text-foreground font-normal", className)}
{...props}
/>
diff --git a/biome.json b/biome.json
index 10a297f72..c74f51ccc 100644
--- a/biome.json
+++ b/biome.json
@@ -1,5 +1,5 @@
{
- "$schema": "https://biomejs.dev/schemas/2.0.6/schema.json",
+ "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
"vcs": {
"enabled": false,
"clientKind": "git",
diff --git a/package.json b/package.json
index a153b2c36..f65eaa05e 100644
--- a/package.json
+++ b/package.json
@@ -9,7 +9,7 @@
"prepare": "husky"
},
"devDependencies": {
- "@biomejs/biome": "2.0.6",
+ "@biomejs/biome": "2.3.10",
"@commitlint/cli": "^19.6.1",
"@commitlint/config-conventional": "^19.6.0",
"esbuild": "0.27.1",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 6487c1b8e..ae834877f 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -13,8 +13,8 @@ importers:
version: 1.5.1
devDependencies:
'@biomejs/biome':
- specifier: 2.0.6
- version: 2.0.6
+ specifier: 2.3.10
+ version: 2.3.10
'@commitlint/cli':
specifier: ^19.6.1
version: 19.8.1(@types/[email protected])([email protected])
@@ -769,55 +769,55 @@ packages:
'@better-fetch/[email protected]':
resolution: {integrity: sha512-/ImESw0sskqlVR94jB+5+Pxjf+xBwDZF/N5+y2/q4EqD7IARUTSpPfIo8uf39SYpCxyOCtbyYpUrZ3F/k0zT4A==}
- '@biomejs/[email protected]':
- resolution: {integrity: sha512-RRP+9cdh5qwe2t0gORwXaa27oTOiQRQvrFf49x2PA1tnpsyU7FIHX4ZOFMtBC4QNtyWsN7Dqkf5EDbg4X+9iqA==}
+ '@biomejs/[email protected]':
+ resolution: {integrity: sha512-/uWSUd1MHX2fjqNLHNL6zLYWBbrJeG412/8H7ESuK8ewoRoMPUgHDebqKrPTx/5n6f17Xzqc9hdg3MEqA5hXnQ==}
engines: {node: '>=14.21.3'}
hasBin: true
- '@biomejs/[email protected]':
- resolution: {integrity: sha512-AzdiNNjNzsE6LfqWyBvcL29uWoIuZUkndu+wwlXW13EKcBHbbKjNQEZIJKYDc6IL+p7bmWGx3v9ZtcRyIoIz5A==}
+ '@biomejs/[email protected]':
+ resolution: {integrity: sha512-M6xUjtCVnNGFfK7HMNKa593nb7fwNm43fq1Mt71kpLpb+4mE7odO8W/oWVDyBVO4ackhresy1ZYO7OJcVo/B7w==}
engines: {node: '>=14.21.3'}
cpu: [arm64]
os: [darwin]
- '@biomejs/[email protected]':
- resolution: {integrity: sha512-wJjjP4E7bO4WJmiQaLnsdXMa516dbtC6542qeRkyJg0MqMXP0fvs4gdsHhZ7p9XWTAmGIjZHFKXdsjBvKGIJJQ==}
+ '@biomejs/[email protected]':
+ resolution: {integrity: sha512-Vae7+V6t/Avr8tVbFNjnFSTKZogZHFYl7MMH62P/J1kZtr0tyRQ9Fe0onjqjS2Ek9lmNLmZc/VR5uSekh+p1fg==}
engines: {node: '>=14.21.3'}
cpu: [x64]
os: [darwin]
- '@biomejs/[email protected]':
- resolution: {integrity: sha512-CVPEMlin3bW49sBqLBg2x016Pws7eUXA27XYDFlEtponD0luYjg2zQaMJ2nOqlkKG9fqzzkamdYxHdMDc2gZFw==}
+ '@biomejs/[email protected]':
+ resolution: {integrity: sha512-B9DszIHkuKtOH2IFeeVkQmSMVUjss9KtHaNXquYYWCjH8IstNgXgx5B0aSBQNr6mn4RcKKRQZXn9Zu1rM3O0/A==}
engines: {node: '>=14.21.3'}
cpu: [arm64]
os: [linux]
- '@biomejs/[email protected]':
- resolution: {integrity: sha512-ZSVf6TYo5rNMUHIW1tww+rs/krol7U5A1Is/yzWyHVZguuB0lBnIodqyFuwCNqG9aJGyk7xIMS8HG0qGUPz0SA==}
+ '@biomejs/[email protected]':
+ resolution: {integrity: sha512-hhPw2V3/EpHKsileVOFynuWiKRgFEV48cLe0eA+G2wO4SzlwEhLEB9LhlSrVeu2mtSn205W283LkX7Fh48CaxA==}
engines: {node: '>=14.21.3'}
cpu: [arm64]
os: [linux]
- '@biomejs/[email protected]':
- resolution: {integrity: sha512-mKHE/e954hR/hSnAcJSjkf4xGqZc/53Kh39HVW1EgO5iFi0JutTN07TSjEMg616julRtfSNJi0KNyxvc30Y4rQ==}
+ '@biomejs/[email protected]':
+ resolution: {integrity: sha512-QTfHZQh62SDFdYc2nfmZFuTm5yYb4eO1zwfB+90YxUumRCR171tS1GoTX5OD0wrv4UsziMPmrePMtkTnNyYG3g==}
engines: {node: '>=14.21.3'}
cpu: [x64]
os: [linux]
- '@biomejs/[email protected]':
- resolution: {integrity: sha512-geM1MkHTV1Kh2Cs/Xzot9BOF3WBacihw6bkEmxkz4nSga8B9/hWy5BDiOG3gHDGIBa8WxT0nzsJs2f/hPqQIQw==}
+ '@biomejs/[email protected]':
+ resolution: {integrity: sha512-wwAkWD1MR95u+J4LkWP74/vGz+tRrIQvr8kfMMJY8KOQ8+HMVleREOcPYsQX82S7uueco60L58Wc6M1I9WA9Dw==}
engines: {node: '>=14.21.3'}
cpu: [x64]
os: [linux]
- '@biomejs/[email protected]':
- resolution: {integrity: sha512-290V4oSFoKaprKE1zkYVsDfAdn0An5DowZ+GIABgjoq1ndhvNxkJcpxPsiYtT7slbVe3xmlT0ncdfOsN7KruzA==}
+ '@biomejs/[email protected]':
+ resolution: {integrity: sha512-o7lYc9n+CfRbHvkjPhm8s9FgbKdYZu5HCcGVMItLjz93EhgJ8AM44W+QckDqLA9MKDNFrR8nPbO4b73VC5kGGQ==}
engines: {node: '>=14.21.3'}
cpu: [arm64]
os: [win32]
- '@biomejs/[email protected]':
- resolution: {integrity: sha512-bfM1Bce0d69Ao7pjTjUS+AWSZ02+5UHdiAP85Th8e9yV5xzw6JrHXbL5YWlcEKQ84FIZMdDc7ncuti1wd2sdbw==}
+ '@biomejs/[email protected]':
+ resolution: {integrity: sha512-pHEFgq7dUEsKnqG9mx9bXihxGI49X+ar+UBrEIj3Wqj3UCZp1rNgV+OoyjFgcXsjCWpuEAF4VJdkZr3TrWdCbQ==}
engines: {node: '>=14.21.3'}
cpu: [x64]
os: [win32]
@@ -6890,39 +6890,39 @@ snapshots:
'@better-fetch/[email protected]': {}
- '@biomejs/[email protected]':
+ '@biomejs/[email protected]':
optionalDependencies:
- '@biomejs/cli-darwin-arm64': 2.0.6
- '@biomejs/cli-darwin-x64': 2.0.6
- '@biomejs/cli-linux-arm64': 2.0.6
- '@biomejs/cli-linux-arm64-musl': 2.0.6
- '@biomejs/cli-linux-x64': 2.0.6
- '@biomejs/cli-linux-x64-musl': 2.0.6
- '@biomejs/cli-win32-arm64': 2.0.6
- '@biomejs/cli-win32-x64': 2.0.6
+ '@biomejs/cli-darwin-arm64': 2.3.10
+ '@biomejs/cli-darwin-x64': 2.3.10
+ '@biomejs/cli-linux-arm64': 2.3.10
+ '@biomejs/cli-linux-arm64-musl': 2.3.10
+ '@biomejs/cli-linux-x64': 2.3.10
+ '@biomejs/cli-linux-x64-musl': 2.3.10
+ '@biomejs/cli-win32-arm64': 2.3.10
+ '@biomejs/cli-win32-x64': 2.3.10
- '@biomejs/[email protected]':
+ '@biomejs/[email protected]':
optional: true
- '@biomejs/[email protected]':
+ '@biomejs/[email protected]':
optional: true
- '@biomejs/[email protected]':
+ '@biomejs/[email protected]':
optional: true
- '@biomejs/[email protected]':
+ '@biomejs/[email protected]':
optional: true
- '@biomejs/[email protected]':
+ '@biomejs/[email protected]':
optional: true
- '@biomejs/[email protected]':
+ '@biomejs/[email protected]':
optional: true
- '@biomejs/[email protected]':
+ '@biomejs/[email protected]':
optional: true
- '@biomejs/[email protected]':
+ '@biomejs/[email protected]':
optional: true