Merge pull request #828 from karrioapi/hotfix-dev-setup

[Hotfix] dev setup

Author: danh91

.env.sample

@@ -5,15 +5,19 @@
 # Core Server Settings
 DEBUG_MODE=True
 ADMIN_DASHBOARD=True
-ALLOWED_HOSTS=*
+ALLOWED_HOSTS=*,localhost,127.0.0.1
 SECRET_KEY="n*s-ex6@ex_r1i%bk=3jd)p+lsick5bi*90!mbk7rc3iy_op1r"
+USE_HTTPS=False
 
-# Database Configuration
+# Database Configuration (SQLite for Development)
 DATABASE_NAME=db.sqlite3
+# Uncomment below for PostgreSQL development
 # DATABASE_ENGINE=postgresql
 # DATABASE_USERNAME=postgres
 # DATABASE_PASSWORD=postgres
 # DATABASE_NAME=db
+# DATABASE_HOST=localhost
+# DATABASE_PORT=5432
 
 # Authentication & Access
 ALLOW_SIGNUP=True
@@ -42,48 +46,3 @@ OIDC_RSA_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nMIIJKQIBAAKCAgEA92+93Tyg6
 
 # Plugin Configuration
 ENABLE_ALL_PLUGINS_BY_DEFAULT=True
-
-# =============================================================================
-# KARRIO DASHBOARD CONFIGURATION
-# =============================================================================
-
-# Dashboard Core Settings
-NEXT_PUBLIC_DASHBOARD_VERSION=2025.X
-NEXT_PUBLIC_KARRIO_PUBLIC_URL=http://localhost:5002
-
-# Multi-tenancy Configuration
-NEXT_PUBLIC_MULTI_TENANT=false
-KARRIO_ADMIN_API_KEY=XXX
-
-# Next.js Authentication Configuration
-AUTH_TRUST_HOST=true
-NEXTAUTH_URL=http://localhost:3000
-NEXTAUTH_SECRET="n*s-ex6@ex_r1i%bk=3jd)p+lsick5bi*90!mbk7rc3iy_op1r"
-
-# Address Autocomplete Service
-NEXT_PUBLIC_ADDRESS_AUTO_COMPLETE_SERVICE=google
-NEXT_PUBLIC_ADDRESS_AUTO_COMPLETE_SERVICE_KEY=xxxxxxxxxxx
-
-# Error Tracking & Monitoring
-SENTRY_IGNORE_API_RESOLUTION_ERROR=1
-# NEXT_PUBLIC_SENTRY_DSN=https://xxxxx
-
-# =============================================================================
-# KARRIO AI AGENT CONFIGURATION (Optional - requires karrio-cli[dev])
-# =============================================================================
-
-# Google AI Studio Configuration (recommended for development)
-GOOGLE_GENAI_USE_VERTEXAI=FALSE
-GOOGLE_API_KEY=YOUR_GOOGLE_API_KEY_HERE
-
-# Google Cloud Vertex AI Configuration (alternative to AI Studio)
-# GOOGLE_GENAI_USE_VERTEXAI=TRUE
-# GOOGLE_CLOUD_PROJECT=YOUR_PROJECT_ID
-# GOOGLE_CLOUD_LOCATION=YOUR_LOCATION
-
-# =============================================================================
-# SHARED/CROSS-CUTTING CONFIGURATION
-# =============================================================================
-
-# Server Communication (used by both server and dashboard)
-# KARRIO_URL=http://localhost:5002

CHANGELOG.md

@@ -1,3 +1,14 @@
+# Karrio 2025.5rc10
+
+## Changes
+
+### Chore
+
+- chore: introduce 'setup-dev-env' for full end-to-end dev environment setup.
+
+> [!IMPORTANT]
+> This release is changing karrio's dashboard default port from `:3000` to `:3002`
+
 # Karrio 2025.5rc9
 
 ## Changes

README.md

@@ -51,7 +51,7 @@ docker compose up
 ```
 
 -   Karrio server accessible at <http://localhost:5002>
--   Karrio dashboard accessible at <http://localhost:3000>
+-   Karrio dashboard accessible at <http://localhost:3002>
 
 Default Login: `admin@example.com` | `demo`
 

apps/api/karrio/server/VERSION

@@ -1 +1 @@
-2025.5rc9
+2025.5rc10

apps/dashboard/.env.sample

@@ -1,25 +1,48 @@
-# karrio dashboard environment variables
+# =============================================================================
+# KARRIO DASHBOARD CONFIGURATION
+# =============================================================================
+
+# Core Dashboard Settings
 NEXT_PUBLIC_DASHBOARD_VERSION=2025.X
 
-# karrio server
+# =============================================================================
+# SERVER INTEGRATION
+# =============================================================================
+
+# Karrio API Server Configuration
 # KARRIO_URL=http://localhost:5002
 NEXT_PUBLIC_KARRIO_PUBLIC_URL=http://localhost:5002
 
-# Required for MULTI_TENANT
-NEXT_PUBLIC_MULTI_TENANT=false
-KARRIO_ADMIN_API_KEY=XXX
+# =============================================================================
+# AUTHENTICATION CONFIGURATION
+# =============================================================================
 
-# next-auth config
+# Next.js Authentication Settings
 AUTH_TRUST_HOST=true
-NEXTAUTH_URL=http://localhost:3000
+NEXTAUTH_URL=http://localhost:3002
 NEXTAUTH_SECRET="n*s-ex6@ex_r1i%bk=3jd)p+lsick5bi*90!mbk7rc3iy_op1r"
 JWT_APP_SECRET_KEY="n*s-ex6@ex_r1i%bk=3jd)p+lsick5bi*90!mbk7rc3iy_op1r"
 
-# Sentry
-# NEXT_PUBLIC_SENTRY_DSN=https://xxxxx
-SENTRY_IGNORE_API_RESOLUTION_ERROR=1
+# =============================================================================
+# MULTI-TENANCY CONFIGURATION
+# =============================================================================
 
-# Address Autocomplete
+# Multi-tenant Settings (Enterprise)
+NEXT_PUBLIC_MULTI_TENANT=false
+KARRIO_ADMIN_API_KEY=XXX
+
+# =============================================================================
+# THIRD-PARTY INTEGRATIONS
+# =============================================================================
+
+# Address Autocomplete Service
 NEXT_PUBLIC_ADDRESS_AUTO_COMPLETE_SERVICE=google # values: canadapost, google
 NEXT_PUBLIC_ADDRESS_AUTO_COMPLETE_SERVICE_KEY=xxxxxxxxxxx
-NEXT_PUBLIC_ADDRESS_AUTO_COMPLETE_SERVICE_KEY=xxxxxxxxxxx
+
+# =============================================================================
+# ERROR TRACKING & MONITORING
+# =============================================================================
+
+# Sentry Configuration
+# NEXT_PUBLIC_SENTRY_DSN=https://xxxxx
+SENTRY_IGNORE_API_RESOLUTION_ERROR=1

apps/dashboard/package.json

@@ -2,7 +2,7 @@
   "name": "@karrio/dashboard",
   "version": "1.0.0",
   "scripts": {
-    "dev": "next dev",
+    "dev": "next dev --port 3002",
     "build": "next build",
     "start": "next start",
     "lint": "next lint"

apps/web/.env.sample

@@ -11,7 +11,7 @@ KARRIO_ADMIN_API_KEY=XXX
 
 # next-auth config
 AUTH_TRUST_HOST=true
-NEXTAUTH_URL=http://localhost:3000
+NEXTAUTH_URL=http://localhost:3002
 NEXTAUTH_SECRET="n*s-ex6@ex_r1i%bk=3jd)p+lsick5bi*90!mbk7rc3iy_op1r"
 
 # Sentry

apps/web/src/app/docs/developing/api-development/local-setup/page.mdx

@@ -52,7 +52,7 @@ docker compose ps
 Once running, you should have:
 
 - **API Server**: http://localhost:5002
-- **Dashboard**: http://localhost:3000
+- **Dashboard**: http://localhost:3002
 - **API Documentation**: http://localhost:5002/openapi
 
 ## Testing Your API Setup

apps/web/src/app/docs/products/app-store/api-integration/page.mdx

@@ -786,7 +786,7 @@ export function useWebSocketConnection(appContext) {
       // Attempt to reconnect after 3 seconds
       reconnectTimeoutRef.current = setTimeout(() => {
         connect();
-      }, 3000);
+      }, 3002);
     };
 
     ws.onerror = (error) => {

apps/web/src/app/docs/products/app-store/app-manifest/page.mdx

@@ -347,7 +347,7 @@ Define environment-specific settings.
 export const manifest: AppManifest = {
   environment: {
     development: {
-      api_base_url: "http://localhost:3000",
+      api_base_url: "http://localhost:3002",
       debug: true,
     },
     staging: {