Skip to content

Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.

🔧 Integrate portless for named local dev URLs (#2290)

Luke Vella4b9fc89cb90f
diff --git a/.env.development b/.env.development
deleted file mode 100644
index 90d0e02ab..000000000
--- a/.env.development
+++ /dev/null
@@ -1,28 +0,0 @@
-# A random 32-character secret key used to encrypt user sessions
-SECRET_PASSWORD=abcdef1234567890abcdef1234567890
-
-# The base url where this instance is accessible, including the scheme.
-# Example: https://example.com
-NEXT_PUBLIC_BASE_URL=http://localhost:3000
-
-# A connection string to your Postgres database
-DATABASE_URL="postgres://postgres:postgres@localhost:5450/rallly"
-
-# A connection string to your Postgres database for direct access (used for migrations)
-DIRECT_DATABASE_URL="postgres://postgres:postgres@localhost:5450/rallly"
-
-# Required to be able to send emails
-
-# Toggle Self-Hosted mode
-NEXT_PUBLIC_SELF_HOSTED=false
-
-# Suppress warning from sentry during local development
-SENTRY_IGNORE_API_RESOLUTION_ERROR=1
-
-# Mailhog SMTP settings
-SMTP_HOST=0.0.0.0
-SMTP_PORT=1025
-SMTP_SECURE=false
-SMTP_USER=
-SMTP_PWD=
\ No newline at end of file
diff --git a/CLAUDE.md b/CLAUDE.md
index d28a0a584..9284725fe 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -23,7 +23,8 @@ Rallly is a meeting scheduling application built with Next.js that allows users
pnpm install
# Setup environment
-cp .env.development .env
+cp apps/web/.env.sample apps/web/.env
+cp packages/database/.env.sample packages/database/.env
# Generate Prisma client
pnpm db:generate
diff --git a/README.md b/README.md
index 607d1f202..9b80ab66b 100644
--- a/README.md
+++ b/README.md
@@ -43,13 +43,14 @@ The following instructions are for running the project locally for development.
3. Setup environment variables
- Create a `.env` file by copying `.env.development`. This will be were you can set your [configuration options](https://support.rallly.co/self-hosting/configuration-options).
+ Copy the sample environment file and fill in the required values:
```bash
- cp .env.development .env
+ cp apps/web/.env.sample apps/web/.env
+ cp packages/database/.env.sample packages/database/.env
```
- **Note:** `.env.development` is preconfigured with default values for development. You can leave these as is for local development.
+ See [configuration options](https://support.rallly.co/self-hosting/configuration-options) for a full list of available options.
4. Generate Prisma client
diff --git a/apps/landing/.env.sample b/apps/landing/.env.sample
new file mode 100644
index 000000000..ec24e7def
--- /dev/null
+++ b/apps/landing/.env.sample
@@ -0,0 +1,15 @@
+# URL of the main web app
+NEXT_PUBLIC_APP_BASE_URL=http://web.rallly.localhost:1355
+
+# The base url where the landing page is accessible, including the scheme.
+NEXT_PUBLIC_BASE_URL=http://landing.rallly.localhost:1355
+
+# For HTTPS:
+# 1. run "pnpm portless proxy start --https"
+# 2. uncomment the following lines
+# PORTLESS_HTTPS=1
+# NEXT_PUBLIC_APP_BASE_URL=https://web.rallly.localhost:1355
+# NEXT_PUBLIC_BASE_URL=https://landing.rallly.localhost:1355
+
+# A connection string to your Postgres database
+DATABASE_URL=postgres://postgres:postgres@localhost:5450/rallly
diff --git a/apps/landing/package.json b/apps/landing/package.json
index 3192818de..a9f0732d2 100644
--- a/apps/landing/package.json
+++ b/apps/landing/package.json
@@ -3,7 +3,7 @@
"version": "0.0.0",
"private": true,
"scripts": {
- "dev": "cross-env PORT=3001 TAILWIND_MODE=watch next dev --turbopack",
+ "dev": "portless landing.rallly cross-env TAILWIND_MODE=watch next dev --turbopack",
"build": "next build",
"analyze": "cross-env ANALYZE=true next build",
"start": "next start",
diff --git a/apps/web/.env.sample b/apps/web/.env.sample
new file mode 100644
index 000000000..c62b45ce2
--- /dev/null
+++ b/apps/web/.env.sample
@@ -0,0 +1,43 @@
+# A secret key used to encrypt user sessions (required, at least 32 characters)
+# Generate a random secret key using: openssl rand -hex 32
+SECRET_PASSWORD=
+
+# The base url where this instance is accessible, including the scheme.
+# Example: https://example.com
+# Default below is configured for the local development server using Portless (see: https://port1355.dev)
+NEXT_PUBLIC_BASE_URL=http://web.rallly.localhost:1355
+## For HTTPS:
+# 1. run "pnpm portless proxy start --https"
+# 2. uncomment the following lines
+# PORTLESS_HTTPS=1
+# NEXT_PUBLIC_BASE_URL=https://web.rallly.localhost:1355
+
+# A connection string to your Postgres database
+DATABASE_URL=postgres://postgres:postgres@localhost:5450/rallly
+
+# Required to be able to send emails
+
+# SMTP settings for sending emails
+# Defaults below are configured for the local Mailpit instance (see docker-compose.dev.yml)
+SMTP_HOST=0.0.0.0
+SMTP_PORT=1025
+SMTP_SECURE=false
+SMTP_USER=
+SMTP_PWD=
+
+# Object Storage (S3) (optional)
+# Defaults below are configured for the local MinIO instance (see docker-compose.dev.yml)
+S3_BUCKET_NAME=rallly
+S3_ENDPOINT=http://0.0.0.0:9000
+S3_ACCESS_KEY_ID=minio
+S3_SECRET_ACCESS_KEY=minio123
+
+# KV (Redis) (optional)
+# Defaults below are configured for the local Redis instance (see docker-compose.dev.yml)
+KV_REST_API_URL=http://0.0.0.0:8079
+KV_REST_API_TOKEN=dev_fake_token_123456789abcdefghijklmnop
+
+# Toggle Self-Hosted mode
+# Enable to remove the pay-wall and subscription billing functionality
+NEXT_PUBLIC_SELF_HOSTED=false
diff --git a/apps/web/package.json b/apps/web/package.json
index 08b24c071..30cbefd8b 100644
--- a/apps/web/package.json
+++ b/apps/web/package.json
@@ -3,7 +3,7 @@
"version": "0.0.0",
"private": true,
"scripts": {
- "dev": "next dev",
+ "dev": "portless web.rallly next dev",
"build": "next build",
"build:test": "NODE_ENV=test next build",
"analyze": "cross-env ANALYZE=true next build",
diff --git a/package.json b/package.json
index 49eb83cc4..7c98ca35d 100644
--- a/package.json
+++ b/package.json
@@ -5,7 +5,7 @@
"scripts": {
"dev": "turbo dev --filter=@rallly/web",
"dev:emails": "turbo dev --filter=@rallly/emails",
- "dev:landing": "dotenv -c development turbo dev --filter=@rallly/landing",
+ "dev:landing": "turbo dev --filter=@rallly/landing",
"start": "turbo run start --filter=@rallly/web",
"build": "dotenv -c -- turbo run build --filter=@rallly/web",
"build:web": "NEXT_PUBLIC_APP_VERSION=$(node scripts/inject-version.js) turbo run build --filter=@rallly/web",
@@ -39,6 +39,7 @@
"dotenv-cli": "^8.0.0",
"husky": "^9.1.7",
"lint-staged": "^16.2.7",
+ "portless": "^0.7.2",
"prettier": "^3.5.3",
"prisma": "^7.3.0",
"turbo": "^2.6.3",
diff --git a/packages/database/.env.sample b/packages/database/.env.sample
new file mode 100644
index 000000000..91099fb95
--- /dev/null
+++ b/packages/database/.env.sample
@@ -0,0 +1,2 @@
+# A connection string to your Postgres database
+DATABASE_URL=postgres://postgres:postgres@localhost:5450/rallly
diff --git a/packages/database/prisma.config.ts b/packages/database/prisma.config.ts
index 144a2bd00..3c982bb67 100644
--- a/packages/database/prisma.config.ts
+++ b/packages/database/prisma.config.ts
@@ -2,7 +2,7 @@ import path from "node:path";
import { defineConfig } from "prisma/config";
try {
- process.loadEnvFile(path.join(__dirname, "../../.env"));
+ process.loadEnvFile(path.join(__dirname, ".env"));
} catch {
console.info("No .env file found, continuing without it");
}
diff --git a/packages/emails/package.json b/packages/emails/package.json
index 4ebab9486..2c346789d 100644
--- a/packages/emails/package.json
+++ b/packages/emails/package.json
@@ -3,7 +3,7 @@
"version": "0.0.0",
"private": true,
"scripts": {
- "dev": "email dev --port 3333 --dir ./src/previews",
+ "dev": "email dev --dir ./src/previews",
"type-check": "tsc --pretty --noEmit",
"i18n:scan": "i18next-scanner --config i18next-scanner.config.js"
},
@@ -30,7 +30,7 @@
"@rallly/tailwind-config": "workspace:*",
"@rallly/tsconfig": "workspace:*",
"@rallly/utils": "workspace:*",
- "@react-email/preview-server": "5.0.8",
+ "@react-email/preview-server": "5.2.7",
"@types/nodemailer": "^6.4.14",
"react-email": "^5.0.8"
}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index b349d23b7..0beb57474 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -23,6 +23,9 @@ importers:
lint-staged:
specifier: ^16.2.7
version: 16.2.7
+ portless:
+ specifier: ^0.7.2
+ version: 0.7.2
prettier:
specifier: ^3.5.3
version: 3.8.1
@@ -635,8 +638,8 @@ importers:
specifier: workspace:*
version: link:../utils
'@react-email/preview-server':
- specifier: 5.0.8
+ specifier: 5.2.7
'@types/nodemailer':
specifier: ^6.4.14
version: 6.4.22
@@ -2762,14 +2765,14 @@ packages:
resolution: {integrity: sha512-ee2kagdTaeEWPlotgdTOqFHYcD3e2m2bbE3I9Rq2i6ABYi5OgopmtEUe8NM23viaYxLV2tDH/2nd5+qKoEr6cw==}
- resolution: {integrity: sha512-6284pl8c8n9PQidN63qjPVEu1uXXKjnmbmaLebOzIfTrSXdGiAPsIMRi4pk/+v/ezqweE1/B8bFqiAAfC6lMXg==}
+ resolution: {integrity: sha512-hULMheQaOhFK1vAoFPigXca42LguwyLILtJKPRzpY1d+og6jk0YNAQVwLGNYYhWEMd2zj4gcIWSf1yC5PffqqA==}
resolution: {integrity: sha512-N1ySLuZjnAtN3kFnwhAwPvZah8RJxKasD7x1f8shFqhncnWZn4JMfg37diLNuoHsLAlrDfM3g4mawVdtAG8XLQ==}
- resolution: {integrity: sha512-j06fWg/gPqiWjK+sEpCDsh5gX+Bdy9gnPYjFqMBvBEOIcCFy1/ecF6pY6XAce7WyCJAbBPVb+6GvpmUZKNq0oQ==}
+ resolution: {integrity: sha512-3G7Rx6m6tgLqkc3Ce3QY/Yrsx7nJF4ithdHfx70Jmzel8m2xpjnGRC+oB4UcCHvQwN0ZP5YsLJakwx/M0vWbSQ==}
engines: {node: '>= 10'}
cpu: [arm64]
os: [darwin]
@@ -2780,8 +2783,8 @@ packages:
cpu: [arm64]
os: [darwin]
- resolution: {integrity: sha512-FRYYz5GSKUkfvDSjd5hgHME2LgYjfOLBmhRVltbs3oRNQQf9n5UTQMmIu/u5vpkjJFV4L2tqo8duGqDxdQOFwg==}
+ resolution: {integrity: sha512-poUTsYKRwuG+eApDngouEiN6AGcAMq8TAQYP8Nou7iMS7x6+q3dFhhyhgodIzTF9acsEINl4cIzMaM9XJor8kw==}
engines: {node: '>= 10'}
cpu: [x64]
os: [darwin]
@@ -2792,8 +2795,8 @@ packages:
cpu: [x64]
os: [darwin]
- resolution: {integrity: sha512-EI2klFVL8tOyEIX5J1gXXpm1YuChmDy4R+tHoNjkCHUmBJqXioYErX/O2go4pEhjxkAxHp2i8y5aJcRz2m5NqQ==}
+ resolution: {integrity: sha512-Q9shvB+eLNrK/n8w+/ZTWSzbEIzJ56mP83ZVaqmHay6/Ulcn6THEId4gxfYCXmSwEG/xPAtv58FBWeZkp36XUA==}
engines: {node: '>= 10'}
cpu: [arm64]
os: [linux]
@@ -2804,8 +2807,8 @@ packages:
cpu: [arm64]
os: [linux]
- resolution: {integrity: sha512-vq/5HeGvowhDPMrpp/KP4GjPVhIXnwNeDPF5D6XK6ta96UIt+C0HwJwuHYlwmn0SWyNANqx1Mp6qSVDXwbFKsw==}
+ resolution: {integrity: sha512-rq+d/a0FZHVPEh3zismoQgfVkSIEzlTbNhD4Z8bToLMszUlggAh1D1syhJ4MHkYzXRszhjS2emy0PYXz7Uwttw==}
engines: {node: '>= 10'}
cpu: [arm64]
os: [linux]
@@ -2816,8 +2819,8 @@ packages:
cpu: [arm64]
os: [linux]
- resolution: {integrity: sha512-GlUdJwy2leA/HnyRYxJ1ZJLCJH+BxZfqV4E0iYLrJipDKxWejWpPtZUdccPmCfIEY9gNBO7bPfbG6IIgkt0qXg==}
+ resolution: {integrity: sha512-82Wroterii1p15O+ZF/DDsHPuxKptR1JGK+obgbAk13vrc3B/fTJ2qOOmdeoMwAQ15gb/9mN4LQl9+IzFje76Q==}
engines: {node: '>= 10'}
cpu: [x64]
os: [linux]
@@ -2828,8 +2831,8 @@ packages:
cpu: [x64]
os: [linux]
- resolution: {integrity: sha512-UCtOVx4N8AHF434VPwg4L0KkFLAd7pgJShzlX/hhv9+FDrT7/xCuVdlBsCXH7l9yCA/wHl3OqhMbIkgUluriWA==}
+ resolution: {integrity: sha512-YK9RoeZuHWBd+wHi5/7VLp6P5ZOldAjQfBjjtzcR4f14FNmwT0a3ozMMlG2txDxh53krAd5yOO601RbJxH0gCQ==}
engines: {node: '>= 10'}
cpu: [x64]
os: [linux]
@@ -2840,8 +2843,8 @@ packages:
cpu: [x64]
os: [linux]
- resolution: {integrity: sha512-tQjtDGtv63mV3n/cZ4TH8BgUvKTSFlrF06yT5DyRmgQuj5WEjBUDy0W3myIW5kTRYMPrLn42H3VfCNwBH6YYiA==}
+ resolution: {integrity: sha512-pcDMpSckekV8xj2SSKO8PaqaJhrmDx84zUNip0kOWsT/ERhhDpnWkr6KXMqRXVp2y5CW9pp4LwOFdtpt3rhRgw==}
engines: {node: '>= 10'}
cpu: [arm64]
os: [win32]
@@ -2852,8 +2855,8 @@ packages:
cpu: [arm64]
os: [win32]
- resolution: {integrity: sha512-y9AGACHTBwnWFLq5B5Fiv3FEbXBusdPb60pgoerB04CV/pwjY1xQNdoTNxAv7eUhU2k1CKnkN4XWVuiK07uOqA==}
+ resolution: {integrity: sha512-Zzo9NLLRzBSHw9zOGpER/gdc5rofZHLjR2OIUIfoBaN2Oo5zWRl43IF5rMSX2LX7MPLTx4Ww8+5lNHAhXgitnA==}
engines: {node: '>= 10'}
cpu: [x64]
os: [win32]
@@ -3911,8 +3914,8 @@ packages:
peerDependencies:
react: ^18.0 || ^19.0 || ^19.0.0-rc
- '@react-email/[email protected]':
- resolution: {integrity: sha512-TyAxXLFSgMDRwUEkCVvazkRYST9LZmYZMkJVv/K1221cMXa7r00R+S0R65lb4EULx397PRULXVWqJAwxyp/wcA==}
+ '@react-email/[email protected]':
+ resolution: {integrity: sha512-3ueOHitbbrbtclkieghHJupwoFFNMGQABBLCTIHFmyY6Gcg2CK7drwFzTFyPd7M756SvmD0E0lTDtoRkSTqrJg==}
'@react-email/[email protected]':
resolution: {integrity: sha512-g/H5fa9PQPDK6WUEG7iTlC19sAktI23qyoiJtMLqQiXFCfWeQMhqjLGKeLSKkfzszqmfJCjZtpSiKtBoOdxp3Q==}
@@ -8396,10 +8399,9 @@ packages:
react: ^16.8 || ^17 || ^18 || ^19 || ^19.0.0-rc
react-dom: ^16.8 || ^17 || ^18 || ^19 || ^19.0.0-rc
- resolution: {integrity: sha512-Xk5x/wEk6ADIAtQECLo1uyE5OagbQCiZ+gW4XEv24FjQ3O2PdSkvgsn22aaseSXC7xg84oONvQjFbSTX5YsMhQ==}
+ resolution: {integrity: sha512-Xlo2aFWaoypPzXr4PFLSNmxrzNptlp+hgxnG9Y2THYvHrvmXIuHUyNAWO6Q+F4rm4/bmTOukprXEyF/j4qsC2A==}
engines: {node: '>=20.9.0'}
- deprecated: This version has a security vulnerability. Please upgrade to a patched version. See https://nextjs.org/blog/security-update-2025-12-11 for more details.
hasBin: true
peerDependencies:
'@opentelemetry/api': ^1.1.0
@@ -8790,6 +8792,12 @@ packages:
resolution: {integrity: sha512-PxkIc/2ZpLiEzQXu5YRDOUgBlfGYBY8156HY5ZcRAwwonMk5W/MrJP2LLkG/hF7GEQzaHo2aS7ho6ZLCOvf+6g==}
engines: {node: '>=12.0.0'}
+ resolution: {integrity: sha512-bwtBBTqCe4K2FL3MMTCMFw3ZEBsv5lJeu9VgVdDqFPhb04jgAaWu3ibXP/dZ6y7OfqV/Vphj0e7Z6bQxcr8uFg==}
+ engines: {node: '>=20'}
+ os: [darwin, linux, win32]
+ hasBin: true
+
resolution: {integrity: sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==}
engines: {node: '>= 0.4'}
@@ -12469,8 +12477,7 @@ snapshots:
'@standard-schema/utils': 0.3.0
react-hook-form: 7.71.1([email protected])
- optional: true
+ '@img/[email protected]': {}
optionalDependencies:
@@ -13300,53 +13307,53 @@ snapshots:
- bufferutil
- utf-8-validate
- '@next/[email protected]': {}
+ '@next/[email protected]': {}
'@next/[email protected]': {}
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
optional: true
@@ -14505,9 +14512,9 @@ snapshots:
md-to-react-email: 5.0.5([email protected])
react: 19.2.4
dependencies:
transitivePeerDependencies:
- '@babel/core'
- '@opentelemetry/api'
@@ -19794,9 +19801,9 @@ snapshots:
react: 19.2.4
react-dom: 19.2.4([email protected])
dependencies:
- '@next/env': 16.0.9
+ '@next/env': 16.0.11
'@swc/helpers': 0.5.15
caniuse-lite: 1.0.30001768
postcss: 8.4.31
@@ -19804,14 +19811,14 @@ snapshots:
react-dom: 19.2.4([email protected])
styled-jsx: 5.1.6(@babel/[email protected])([email protected])
optionalDependencies:
- '@next/swc-darwin-arm64': 16.0.9
- '@next/swc-darwin-x64': 16.0.9
- '@next/swc-linux-arm64-gnu': 16.0.9
- '@next/swc-linux-arm64-musl': 16.0.9
- '@next/swc-linux-x64-gnu': 16.0.9
- '@next/swc-linux-x64-musl': 16.0.9
- '@next/swc-win32-arm64-msvc': 16.0.9
- '@next/swc-win32-x64-msvc': 16.0.9
+ '@next/swc-darwin-arm64': 16.0.11
+ '@next/swc-darwin-x64': 16.0.11
+ '@next/swc-linux-arm64-gnu': 16.0.11
+ '@next/swc-linux-arm64-musl': 16.0.11
+ '@next/swc-linux-x64-gnu': 16.0.11
+ '@next/swc-linux-x64-musl': 16.0.11
+ '@next/swc-win32-arm64-msvc': 16.0.11
+ '@next/swc-win32-x64-msvc': 16.0.11
'@opentelemetry/api': 1.9.0
'@playwright/test': 1.58.1
sharp: 0.34.5
@@ -20218,6 +20225,10 @@ snapshots:
+ dependencies:
+ chalk: 5.6.2
+
@@ -21203,7 +21214,7 @@ snapshots:
dependencies:
decode-ico: 0.4.1
ico-endec: 0.1.6
- sharp: 0.33.5
+ sharp: 0.34.5
dependencies:
@@ -21261,7 +21272,6 @@ snapshots:
'@img/sharp-win32-arm64': 0.34.5
'@img/sharp-win32-ia32': 0.34.5
'@img/sharp-win32-x64': 0.34.5
- optional: true
dependencies: