Skip to content

Your favorite shift management application!

feat: add demo mode functionality with restrictions on calendar editing and deletion (#4)

panteLb8e8bb1cefdf
diff --git a/.env.example b/.env.example
index 0f56e40..2e9388b 100644
--- a/.env.example
+++ b/.env.example
@@ -16,7 +16,10 @@ GITHUB_API_REVALIDATE=3600 # GitHub API revalidation: 1 hour in seconds
# Internationalization (i18n)
DEFAULT_LOCALE=en # Default language if browser detection fails. Options: en, de
-# Application Settings
+# Application Settings (NOT supported on Docker deployments)
NODE_ENV=production
PORT=3000
HOSTNAME=0.0.0.0
+
+# Demo Mode
+# DEMO_MODE=true # Optional: Prevents calendar deletion, password changes, and calendar editing
diff --git a/README.md b/README.md
index cfefc6c..f13c7d8 100644
--- a/README.md
+++ b/README.md
@@ -115,6 +115,28 @@ $ docker compose exec bettershift npm run db:migrate
# Access the application at http://localhost:3000 (or your configured port)
```
+### 🎭 Demo Mode
+
+Demo mode can be enabled to prevent calendar deletion, editing, and password changes. This is useful for public demonstrations or testing environments.
+
+**Enable Demo Mode:**
+
+Set the environment variable `DEMO_MODE=true` in your configuration:
+
+```bash
+# In .env file
+DEMO_MODE=true
+```
+
+**Demo Mode Restrictions:**
+
+- Calendar deletion is disabled
+- Calendar editing (name, color) is disabled
+- Password management is disabled
+- User-friendly toast notifications inform users of these restrictions
+
+**Note:** Shifts, presets, and notes can still be created, edited, and deleted in demo mode.
+
### 🏗️ Production Build
```bash
diff --git a/app/api/calendars/[id]/route.ts b/app/api/calendars/[id]/route.ts
index 6022a95..cd1c4c1 100644
--- a/app/api/calendars/[id]/route.ts
+++ b/app/api/calendars/[id]/route.ts
@@ -3,6 +3,7 @@ import { db } from "@/lib/db";
import { calendars, shifts } from "@/lib/db/schema";
import { eq } from "drizzle-orm";
import { hashPassword, verifyPassword } from "@/lib/password-utils";
+import { isDemoMode } from "@/lib/utils";
// GET single calendar
export async function GET(
@@ -45,6 +46,13 @@ export async function PATCH(
{ params }: { params: Promise<{ id: string }> }
) {
try {
+ if (isDemoMode()) {
+ return NextResponse.json(
+ { error: "Calendar editing is disabled in demo mode" },
+ { status: 403 }
+ );
+ }
+
const { id } = await params;
const body = await request.json();
const { name, color, password, currentPassword } = body;
@@ -104,6 +112,13 @@ export async function DELETE(
{ params }: { params: Promise<{ id: string }> }
) {
try {
+ if (isDemoMode()) {
+ return NextResponse.json(
+ { error: "Calendar deletion is disabled in demo mode" },
+ { status: 403 }
+ );
+ }
+
const { id } = await params;
// Read password from request body
diff --git a/app/api/config/route.ts b/app/api/config/route.ts
new file mode 100644
index 0000000..ba31392
--- /dev/null
+++ b/app/api/config/route.ts
@@ -0,0 +1,8 @@
+import { NextResponse } from "next/server";
+
+// GET config settings
+export async function GET() {
+ return NextResponse.json({
+ demoMode: process.env.DEMO_MODE === "true",
+ });
+}
diff --git a/app/page.tsx b/app/page.tsx
index a15bc79..c92120a 100644
--- a/app/page.tsx
+++ b/app/page.tsx
@@ -112,6 +112,7 @@ function HomeContent() {
const [isTogglingShift, setIsTogglingShift] = useState(false);
const [isConnected, setIsConnected] = useState(true);
const [version, setVersion] = useState<string | null>(null);
+ const [demoMode, setDemoMode] = useState(false);
// SSE Connection for real-time updates
useSSEConnection({
@@ -135,8 +136,20 @@ function HomeContent() {
}
};
+ // Fetch config (demo mode)
+ const fetchConfig = async () => {
+ try {
+ const response = await fetch("/api/config");
+ const data = await response.json();
+ setDemoMode(data.demoMode);
+ } catch (error) {
+ console.error("Failed to fetch config:", error);
+ }
+ };
+
useEffect(() => {
fetchVersion();
+ fetchConfig();
}, []);
// Update URL when selected calendar changes
@@ -556,6 +569,15 @@ function HomeContent() {
return (
<div className="min-h-screen flex flex-col">
+ {demoMode && (
+ <div className="bg-gradient-to-r from-amber-500 via-orange-500 to-amber-500 text-white py-2.5 px-4 text-center text-sm font-medium shadow-lg">
+ <span className="inline-flex items-center gap-2 flex-wrap justify-center">
+ <span className="text-base">🎭</span>
+ <span className="font-semibold">{t("demo.mode")}:</span>
+ <span>{t("demo.bannerMessage")}</span>
+ </span>
+ </div>
+ )}
<AppHeader
calendars={calendars}
selectedCalendar={selectedCalendar}
@@ -563,6 +585,7 @@ function HomeContent() {
selectedPresetId={selectedPresetId}
isConnected={isConnected}
showMobileCalendarDialog={showMobileCalendarDialog}
+ demoMode={demoMode}
onSelectCalendar={setSelectedCalendar}
onSelectPreset={setSelectedPresetId}
onCreateCalendar={() => setShowCalendarDialog(true)}
@@ -725,6 +748,7 @@ function HomeContent() {
!!calendars.find((c) => c.id === selectedCalendar)?.passwordHash
}
onSuccess={refetchCalendars}
+ demoMode={demoMode}
/>
)}
<NoteDialog
@@ -746,6 +770,7 @@ function HomeContent() {
!!calendars.find((c) => c.id === calendarToDelete)?.passwordHash
}
onConfirm={handleDeleteCalendar}
+ demoMode={demoMode}
/>
)}
diff --git a/components/app-header.tsx b/components/app-header.tsx
index fc37090..2bfe6b1 100644
--- a/components/app-header.tsx
+++ b/components/app-header.tsx
@@ -21,6 +21,7 @@ interface AppHeaderProps {
selectedPresetId: string | undefined;
isConnected: boolean;
showMobileCalendarDialog: boolean;
+ demoMode?: boolean;
onSelectCalendar: (id: string) => void;
onSelectPreset: (id: string | undefined) => void;
onCreateCalendar: () => void;
@@ -40,6 +41,7 @@ export function AppHeader({
selectedPresetId,
isConnected,
showMobileCalendarDialog,
+ demoMode = false,
onSelectCalendar,
onSelectPreset,
onCreateCalendar,
@@ -122,6 +124,7 @@ export function AppHeader({
onCreateNew={onCreateCalendar}
onManagePassword={onManagePassword}
onDelete={onDeleteCalendar}
+ demoMode={demoMode}
/>
</div>
</motion.div>
@@ -252,6 +255,7 @@ export function AppHeader({
onManagePassword();
}}
onDelete={onDeleteCalendar}
+ demoMode={demoMode}
/>
</div>
</DialogContent>
diff --git a/components/calendar-selector.tsx b/components/calendar-selector.tsx
index 6a2d47d..e72a09d 100644
--- a/components/calendar-selector.tsx
+++ b/components/calendar-selector.tsx
@@ -11,6 +11,7 @@ import {
} from "@/components/ui/select";
import { Button } from "@/components/ui/button";
import { Plus, KeyRound, Trash2 } from "lucide-react";
+import { toast } from "sonner";
interface CalendarSelectorProps {
calendars: CalendarWithCount[];
@@ -19,6 +20,7 @@ interface CalendarSelectorProps {
onCreateNew: () => void;
onManagePassword?: () => void;
onDelete?: (id: string) => void;
+ demoMode?: boolean;
}
export function CalendarSelector({
@@ -28,9 +30,26 @@ export function CalendarSelector({
onCreateNew,
onManagePassword,
onDelete,
+ demoMode = false,
}: CalendarSelectorProps) {
const t = useTranslations();
+ const handleManagePassword = () => {
+ if (demoMode) {
+ toast.error(t("demo.disabledPassword"));
+ return;
+ }
+ onManagePassword?.();
+ };
+
+ const handleDelete = (id: string) => {
+ if (demoMode) {
+ toast.error(t("demo.disabledDelete"));
+ return;
+ }
+ onDelete?.(id);
+ };
+
return (
<div className="flex gap-2 items-center">
<Select value={selectedId} onValueChange={onSelect}>
@@ -53,22 +72,24 @@ export function CalendarSelector({
</Select>
{onManagePassword && selectedId && (
<Button
- onClick={onManagePassword}
+ onClick={handleManagePassword}
size="icon"
variant="outline"
className="h-9 w-9 sm:h-10 sm:w-10"
title={t("calendar.managePassword")}
+ disabled={demoMode}
>
<KeyRound className="h-4 w-4" />
</Button>
)}
{onDelete && selectedId && (
<Button
- onClick={() => onDelete(selectedId)}
+ onClick={() => handleDelete(selectedId)}
size="icon"
variant="outline"
className="h-9 w-9 sm:h-10 sm:w-10 text-destructive hover:text-destructive"
title={t("calendar.deleteCalendar")}
+ disabled={demoMode}
>
<Trash2 className="h-4 w-4" />
</Button>
diff --git a/components/delete-calendar-dialog.tsx b/components/delete-calendar-dialog.tsx
index ab2b28d..e25a4fb 100644
--- a/components/delete-calendar-dialog.tsx
+++ b/components/delete-calendar-dialog.tsx
@@ -14,6 +14,7 @@ import { Button } from "@/components/ui/button";
import { Input } from "@/components/ui/input";
import { Label } from "@/components/ui/label";
import { AlertTriangle } from "lucide-react";
+import { toast } from "sonner";
interface DeleteCalendarDialogProps {
open: boolean;
@@ -21,6 +22,7 @@ interface DeleteCalendarDialogProps {
calendarName: string;
hasPassword: boolean;
onConfirm: (password?: string) => void;
+ demoMode?: boolean;
}
export function DeleteCalendarDialog({
@@ -29,6 +31,7 @@ export function DeleteCalendarDialog({
calendarName,
hasPassword,
onConfirm,
+ demoMode = false,
}: DeleteCalendarDialogProps) {
const t = useTranslations();
const [password, setPassword] = useState("");
@@ -41,6 +44,10 @@ export function DeleteCalendarDialog({
const handleSubmit = (e: React.FormEvent) => {
e.preventDefault();
+ if (demoMode) {
+ toast.error(t("demo.disabledDelete"));
+ return;
+ }
onConfirm(hasPassword ? password : undefined);
};
diff --git a/components/manage-password-dialog.tsx b/components/manage-password-dialog.tsx
index 8f9c25d..f01fdc4 100644
--- a/components/manage-password-dialog.tsx
+++ b/components/manage-password-dialog.tsx
@@ -14,6 +14,7 @@ import { Button } from "@/components/ui/button";
import { Input } from "@/components/ui/input";
import { Label } from "@/components/ui/label";
import { Checkbox } from "@/components/ui/checkbox";
+import { toast } from "sonner";
interface ManagePasswordDialogProps {
open: boolean;
@@ -22,6 +23,7 @@ interface ManagePasswordDialogProps {
calendarName: string;
hasPassword: boolean;
onSuccess: () => void;
+ demoMode?: boolean;
}
export function ManagePasswordDialog({
@@ -31,6 +33,7 @@ export function ManagePasswordDialog({
calendarName,
hasPassword,
onSuccess,
+ demoMode = false,
}: ManagePasswordDialogProps) {
const t = useTranslations();
const [currentPassword, setCurrentPassword] = useState("");
@@ -54,6 +57,11 @@ export function ManagePasswordDialog({
e.preventDefault();
setError("");
+ if (demoMode) {
+ toast.error(t("demo.disabledPassword"));
+ return;
+ }
+
// Validate inputs
if (hasPassword && !currentPassword) {
setError(t("password.errorRequired"));
diff --git a/lib/utils.ts b/lib/utils.ts
index a5ef193..e0c8b47 100644
--- a/lib/utils.ts
+++ b/lib/utils.ts
@@ -4,3 +4,12 @@ import { twMerge } from "tailwind-merge";
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}
+
+export function isDemoMode(): boolean {
+ // Server-side: check actual environment variable
+ if (typeof window === "undefined") {
+ return process.env.DEMO_MODE === "true";
+ }
+ // Client-side: will be passed via props or API
+ return false;
+}
diff --git a/messages/de.json b/messages/de.json
index 6bb6919..febf05d 100644
--- a/messages/de.json
+++ b/messages/de.json
@@ -157,5 +157,13 @@
},
"version": {
"label": "Version"
+ },
+ "demo": {
+ "mode": "Demo-Modus",
+ "disabledAction": "Diese Aktion ist im Demo-Modus deaktiviert",
+ "disabledDelete": "Löschen im Demo-Modus deaktiviert",
+ "disabledEdit": "Bearbeiten im Demo-Modus deaktiviert",
+ "disabledPassword": "Passwortverwaltung im Demo-Modus deaktiviert",
+ "bannerMessage": "Kalender löschen, bearbeiten und Passwörter verwalten ist deaktiviert"
}
}
diff --git a/messages/en.json b/messages/en.json
index 8a52dee..23fb09f 100644
--- a/messages/en.json
+++ b/messages/en.json
@@ -157,5 +157,13 @@
},
"version": {
"label": "Version"
+ },
+ "demo": {
+ "mode": "Demo Mode",
+ "disabledAction": "This action is disabled in demo mode",
+ "disabledDelete": "Deletion disabled in demo mode",
+ "disabledEdit": "Editing disabled in demo mode",
+ "disabledPassword": "Password management disabled in demo mode",
+ "bannerMessage": "Calendar deletion, editing and password management are disabled"
}
}