@django-stack/cli 0.10.0 → 0.12.0

package/dist/{production-Ct_qoeXk.js → production-1O8-1QUl.js}

@@ -258,9 +258,10 @@ async function runDoctor(directory) {
 	const services = running ? running.split("\n").filter(Boolean) : [];
 	const backendService = prod ? "backend-prod" : "backend";
 	const frontendService = prod ? "frontend-prod" : "frontend";
+	const frontend = existsSync(join(directory, "frontend", "package.json"));
 	checks.push({
 		name: "Services are running",
-		ok: services.includes(backendService) && services.includes(frontendService),
+		ok: services.includes(backendService) && (!frontend || services.includes(frontendService)),
 		warning: services.length === 0,
 		detail: services.length ? services.join(", ") : `Nothing is running. Start the project with \`docker compose up${prod ? " -d" : ""}\`.`
 	});
@@ -278,11 +279,12 @@ async function runDoctor(directory) {
 		detail: health ? `The ${backendService} container is ${health}` : `See \`docker compose logs ${backendService}\`.`
 	});
 	const site = (env.SITE_URL ?? "http://localhost:3000").replace(/\/$/, "");
-	const frontend = await fetchStatus(site);
+	const status = await fetchStatus(site);
+	const logs = prod ? "proxy" : frontend ? frontendService : backendService;
 	checks.push({
 		name: "The site answers",
-		ok: frontend !== void 0 && frontend < 500,
-		detail: frontend ? `${site} answered ${frontend}` : `No answer on ${site}. See \`docker compose logs ${prod ? "proxy" : frontendService}\`.`
+		ok: status !== void 0 && status < 500,
+		detail: status ? `${site} answered ${status}` : `No answer on ${site}. See \`docker compose logs ${logs}\`.`
 	});
 	const api = await fetchStatus(`${site}/api/content.sitesettings`, { "X-Secret-Key": env.API_READ_KEY ?? "" });
 	checks.push({
@@ -461,13 +463,13 @@ const STACK_OPTIONS = [
 				value: "headless",
 				label: "Headless",
 				hint: "just the API and the admin",
-				generated: false
+				generated: true
 			},
 			{
 				value: "templates",
 				label: "Django templates",
 				hint: "no Node, Django renders the site",
-				generated: false
+				generated: true
 			},
 			{
 				value: "nuxt",
@@ -498,7 +500,7 @@ const STACK_OPTIONS = [
 			value: "latest",
 			label: "Latest",
 			hint: "Postgres 18",
-			generated: false
+			generated: true
 		}]
 	},
 	{
@@ -726,9 +728,13 @@ const NODE_FRONTENDS = [
 	"nuxt",
 	"sveltekit"
 ];
-/** Whether an option applies to a stack: the package manager only with a Node frontend. */
+/**
+* Whether an option applies to a stack: the package manager only with a Node
+* frontend, page analytics only with a frontend for its tracker.
+*/
 function applies(key, stack) {
 	if (key === "packageManager") return stack.frontend === void 0 || NODE_FRONTENDS.includes(stack.frontend);
+	if (key === "analytics") return stack.frontend !== "headless";
 	return true;
 }
 const DIGITS = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
@@ -916,6 +922,10 @@ function projectName(directory) {
 	} catch {}
 	return basename(directory).toLowerCase();
 }
+/** Whether the project has a frontend: a headless one has no `frontend/`. */
+function hasFrontend(directory) {
+	return existsSync(join(directory, "frontend", "package.json"));
+}
 function fromEnv(directory, name, envFile, localRun) {
 	const env = parseEnv(readFileSync(join(directory, envFile), "utf8"));
 	const profiles = parseProfiles(env.COMPOSE_PROFILES);
@@ -930,7 +940,7 @@ function fromEnv(directory, name, envFile, localRun) {
 		localRun,
 		services: {
 			backend: `backend${suffix}`,
-			frontend: `frontend${suffix}`,
+			...hasFrontend(directory) ? { frontend: `frontend${suffix}` } : {},
 			worker: `worker${suffix}`
 		},
 		composeArgs: localRun ? [
@@ -1161,6 +1171,23 @@ const PACKAGE_NAME = "@django-stack/cli";
 // src/scaffold.ts
 /** The frontends this version of the CLI generates. */
 const FRONTENDS = stackOption("frontend").values.filter((value) => value.generated).map((value) => value.value);
+/** The Postgres major version of each `--postgres` value. */
+const POSTGRES_VERSIONS = {
+	stable: "17",
+	latest: "18"
+};
+/**
+* The template values of a Postgres version. From 18 the image keeps its data
+* in a versioned directory under /var/lib/postgresql, so the volume is
+* mounted there; before 18 at /var/lib/postgresql/data.
+*/
+function postgresValues(postgres) {
+	const version = POSTGRES_VERSIONS[postgres];
+	return {
+		postgres_version: version,
+		postgres_data: Number(version) >= 18 ? "/var/lib/postgresql" : "/var/lib/postgresql/data"
+	};
+}
 /** The pnpm and Bun versions the frontend image installs with. */
 const PNPM_VERSION = "12.18.0";
 const BUN_VERSION = "1.4.4";
@@ -1289,7 +1316,7 @@ function localS3(port = 8333) {
 	};
 }
 const LOCAL_S3 = localS3();
-const TEXT_EXTENSIONS = /\.(py|ts|tsx|mjs|js|jsx|json|astro|vue|svelte|css|md|yaml|yml|toml|txt|html|sh|svg)$|Dockerfile$|gitignore$|\.dockerignore$|env\.example$/;
+const TEXT_EXTENSIONS = /\.(py|ts|tsx|mjs|js|jsx|json|astro|vue|svelte|css|md|yaml|yml|toml|txt|html|sh|svg)$|Dockerfile$|Caddyfile$|gitignore$|\.dockerignore$|env\.example$/;
 function defaultTemplatesDir() {
 	return fileURLToPath(new URL("../templates", import.meta.url));
 }
@@ -1323,6 +1350,35 @@ function walk(directory) {
 		return statSync(path).isDirectory() ? walk(path) : [path];
 	});
 }
+const BLOCK_START = /^\s*(?:#|<!--)\s*@if\s+(!?)([a-z]+)\s*(?:-->)?\s*$/;
+const BLOCK_END = /^\s*(?:#|<!--)\s*@end\s*(?:-->)?\s*$/;
+/**
+* Keeps or drops the template's conditional blocks: the lines between a
+* comment line `# @if frontend` (or `<!-- @if !frontend -->`) and `# @end`
+* stay when the flag is on (off with `!`). The marker lines always go.
+*/
+function selectBlocks(text, flags) {
+	if (!/@(if|end)\b/.test(text)) return text;
+	const kept = [];
+	const open = [];
+	for (const line of text.split("\n")) {
+		const start = line.match(BLOCK_START);
+		if (start) {
+			const flag = flags[start[2]];
+			if (flag === void 0) throw new Error(`Unknown template flag ${start[2]}.`);
+			open.push(start[1] ? !flag : flag);
+			continue;
+		}
+		if (BLOCK_END.test(line)) {
+			if (!open.length) throw new Error("@end without @if.");
+			open.pop();
+			continue;
+		}
+		if (open.every(Boolean)) kept.push(line);
+	}
+	if (open.length) throw new Error("@if without @end.");
+	return kept.join("\n");
+}
 function render(text, values) {
 	return text.replace(/\{\{([a-z_]+)\}\}/g, (match, key) => values[key] ?? match);
 }
@@ -1334,6 +1390,16 @@ function validateTimeZone(value) {
 	if (timeZones().includes(value)) return void 0;
 	return `${JSON.stringify(value)} is not a time zone. Use a name such as Europe/Amsterdam or UTC.`;
 }
+/** The root package.json of a headless project: the scripts without the frontend's steps. */
+function headlessScripts(text) {
+	const manifest = JSON.parse(text);
+	const scripts = manifest.scripts;
+	scripts.test = "docker compose exec backend pytest";
+	scripts.lint = "docker compose exec backend ruff check .";
+	scripts["generate:types"] = (scripts["generate:types"] ?? "").split(" && ")[0] ?? "";
+	manifest.description = manifest.description.replace(", Content Studio and Headless,", " and Content Studio,");
+	return `${JSON.stringify(manifest, null, 2)}\n`;
+}
 function scaffold(options) {
 	const templates = options.templatesDir ?? defaultTemplatesDir();
 	const target = options.directory;
@@ -1344,17 +1410,28 @@ function scaffold(options) {
 		const zoneError = validateTimeZone(options.timeZone);
 		if (zoneError) throw new Error(zoneError);
 	}
+	const headless = options.frontend === "headless";
+	const djangoTemplates = options.frontend === "templates";
+	const jsFrontend = !headless && !djangoTemplates;
 	const frontendTemplate = join(templates, `frontend-${options.frontend}`);
-	if (!existsSync(frontendTemplate)) throw new Error(`This version of the CLI has no ${options.frontend} frontend.`);
+	if (!headless && !existsSync(frontendTemplate)) throw new Error(`This version of the CLI has no ${options.frontend} frontend.`);
 	mkdirSync(target, { recursive: true });
 	cpSync(join(templates, "base"), target, { recursive: true });
 	cpSync(join(templates, "backend"), join(target, "backend"), { recursive: true });
-	cpSync(frontendTemplate, join(target, "frontend"), { recursive: true });
+	const frontendDir = join(target, djangoTemplates ? "backend" : "frontend");
+	if (!headless) cpSync(frontendTemplate, frontendDir, { recursive: true });
 	renameSync(join(target, "gitignore"), join(target, ".gitignore"));
 	makeExecutable(target);
-	const about = join(target, "frontend", "template.json");
-	const frontend = JSON.parse(readFileSync(about, "utf8"));
-	rmSync(about);
+	let frontend = {
+		label: "Headless",
+		url: "",
+		security: ""
+	};
+	if (!headless) {
+		const about = join(frontendDir, "template.json");
+		frontend = JSON.parse(readFileSync(about, "utf8"));
+		rmSync(about);
+	}
 	const packageManager = options.packageManager ?? "pnpm";
 	const values = {
 		project_name: options.name,
@@ -1366,17 +1443,24 @@ function scaffold(options) {
 		preset: options.preset ?? encodePreset(DEFAULT_STACK),
 		site_port: String(options.ports?.SITE_PORT ?? 3e3),
 		mail_port: String(options.ports?.MAIL_PORT ?? 8025),
-		...packageManagerValues(packageManager)
+		...packageManagerValues(packageManager),
+		...postgresValues(options.postgres ?? DEFAULT_STACK.postgres)
 	};
 	const files = walk(target);
 	for (const file of files) {
 		if (!TEXT_EXTENSIONS.test(file)) continue;
 		const text = readFileSync(file, "utf8");
-		const rendered = render(text, values);
+		const rendered = render(selectBlocks(text, {
+			frontend: jsFrontend,
+			headless,
+			templates: djangoTemplates,
+			site: !headless
+		}), values);
 		if (rendered !== text) writeFileSync(file, rendered);
 	}
+	if (!jsFrontend) writeFileSync(join(target, "package.json"), headlessScripts(readFileSync(join(target, "package.json"), "utf8")));
 	if (packageManager !== "pnpm") rmSync(join(target, "frontend", "pnpm-workspace.yaml"), { force: true });
-	if (packageManager !== "npm") {
+	if (jsFrontend && packageManager !== "npm") {
 		const packageJson = join(target, "frontend", "package.json");
 		const manifest = JSON.parse(readFileSync(packageJson, "utf8"));
 		const version = packageManager === "pnpm" ? PNPM_VERSION : BUN_VERSION;
@@ -1398,14 +1482,13 @@ function scaffold(options) {
 	const secrets = generateProjectSecrets();
 	let env = template.replace(/\{\{secret:([a-z_]+)\}\}/g, (match, key) => secrets[key] ?? match);
 	const envExample = template.replace(/\{\{secret:[a-z_]+\}\}/g, "");
-	const profiles = ["dev"];
-	if (options.databaseUrl) env = setEnvValues(env, { DATABASE_URL: normalizeDatabaseUrl(options.databaseUrl) });
-	else profiles.push("db");
+	const profiles = ["dev", "db"];
+	if (options.databaseUrl) env = setEnvValues(env, { PRODUCTION_DATABASE_URL: normalizeDatabaseUrl(options.databaseUrl) });
 	if (options.localS3) {
 		profiles.push("s3");
 		env = setEnvValues(env, LOCAL_S3);
 	}
-	if (options.analytics) {
+	if (options.analytics && !headless) {
 		profiles.push("analytics");
 		env = setEnvValues(env, umamiEnv(parseEnv(env).DATABASE_URL ?? "", secrets));
 	}
@@ -1456,6 +1539,10 @@ function linkPackages(target, monorepo) {
 	const pyproject = join(target, "backend", "pyproject.toml");
 	writeFileSync(pyproject, `${readFileSync(pyproject, "utf8").trimEnd()}\n\n[tool.uv.sources]\ndjango-stack = { path = "vendor/${wheel}" }\n`);
 	const packageJson = join(target, "frontend", "package.json");
+	if (!existsSync(packageJson)) {
+		rmSync(frontendVendor, { recursive: true });
+		return;
+	}
 	const manifest = JSON.parse(readFileSync(packageJson, "utf8"));
 	const packages = Object.keys(manifest.dependencies ?? {}).filter((name) => name.startsWith("@django-stack/"));
 	for (const name of packages) {
@@ -1568,6 +1655,16 @@ function relativeDirectory(directory) {
 	return path.startsWith("..") ? directory : path;
 }
 // src/production.ts
+/**
+* A Postgres URL from its parts, with the user name, password and database
+* name URL-encoded, so a password with `@`, `:`, `/` or `#` still works.
+* Hosts other than this machine get `sslmode=require`.
+*/
+function postgresUrl(parts) {
+	const host = parts.host.includes(":") && !parts.host.startsWith("[") ? `[${parts.host}]` : parts.host;
+	const password = parts.password ? `:${encodeURIComponent(parts.password)}` : "";
+	return normalizeDatabaseUrl(`postgres://${encodeURIComponent(parts.user)}${password}@${host}:${parts.port || "5432"}/${encodeURIComponent(parts.name)}`);
+}
 /** The S3 settings that uploads to S3 need and that are empty. */
 function missingS3(env) {
 	return [
@@ -1607,7 +1704,12 @@ function productionEnv(devEnv, options) {
 		ADMIN_PASSWORD: secrets.admin ?? "",
 		DEFAULT_FROM_EMAIL: `${current.PROJECT_NAME ?? "site"} <noreply@${options.domain.toLowerCase()}>`
 	};
-	if (profiles.includes("db")) {
+	const external = options.bundledDatabase ? "" : options.databaseUrl ? normalizeDatabaseUrl(options.databaseUrl) : current.PRODUCTION_DATABASE_URL ?? "";
+	if (external) {
+		values.DATABASE_URL = external;
+		values.POSTGRES_PASSWORD = "";
+		values.COMPOSE_PROFILES = [...new Set(profiles.filter((profile) => profile !== "db"))].join(",");
+	} else if (profiles.includes("db")) {
 		const user = current.POSTGRES_USER || "app";
 		const name = current.POSTGRES_DB || "app";
 		values.POSTGRES_PASSWORD = secrets.postgres ?? "";
@@ -1644,4 +1746,4 @@ function productionEnv(devEnv, options) {
 		todo
 	};
 }
-export { envPorts as $, compose as A, NAMED_PRESETS as B, PACKAGE_NAME as C, RUN_DOMAIN as D, CAPTCHA_APP as E, projectUrls as F, decodePreset as G, PROMPT_ORDER as H, readLocalRun as I, resolvePreset as J, encodePreset as K, readProject as L, findProjectDirectory as M, parseProfiles as N, RUN_ENV as O, projectStack as P, describeMove as Q, runningServices as R, CLI_VERSION as S, generateSecret as T, STACK_OPTIONS as U, NODE_FRONTENDS as V, applies as W, DEV_PORTS as X, stackOption as Y, chooseFreePorts as Z, umamiEnv as _, LOCAL_S3 as a, isDockerDown as at, validateProjectName as b, localS3 as c, setEnvValues as ct, normalizeDatabaseUrl as d, portValues as et, relativeDirectory as f, toProjectName as g, timeZones as h, FRONTENDS as i, dockerRunning as it, composeOutput as j, activeProject as k, lockBackend as l, setNotificationsApp as m, productionEnv as n, checkTools as nt, cacheEnv as o, parseEnv as ot, scaffold as p, pendingChoices as q, validateDomain as r, dockerNotRunning as rt, frontendPackageManager as s, quoteEnvValue as st, missingS3 as t, runDoctor as tt, lockFrontend as u, updateFrontendLock as v, generateProjectSecrets as w, validateTimeZone as x, usesValkey as y, DEFAULT_STACK as z };
+export { describeMove as $, activeProject as A, DEFAULT_STACK as B, CLI_VERSION as C, CAPTCHA_APP as D, generateSecret as E, projectStack as F, applies as G, NODE_FRONTENDS as H, projectUrls as I, pendingChoices as J, decodePreset as K, readLocalRun as L, composeOutput as M, findProjectDirectory as N, RUN_DOMAIN as O, parseProfiles as P, chooseFreePorts as Q, readProject as R, validateTimeZone as S, generateProjectSecrets as T, PROMPT_ORDER as U, NAMED_PRESETS as V, STACK_OPTIONS as W, stackOption as X, resolvePreset as Y, DEV_PORTS as Z, toProjectName as _, FRONTENDS as a, dockerRunning as at, usesValkey as b, frontendPackageManager as c, quoteEnvValue as ct, lockFrontend as d, envPorts as et, normalizeDatabaseUrl as f, timeZones as g, setNotificationsApp as h, validateDomain as i, dockerNotRunning as it, compose as j, RUN_ENV as k, localS3 as l, setEnvValues as lt, scaffold as m, postgresUrl as n, runDoctor as nt, LOCAL_S3 as o, isDockerDown as ot, relativeDirectory as p, encodePreset as q, productionEnv as r, checkTools as rt, cacheEnv as s, parseEnv as st, missingS3 as t, portValues as tt, lockBackend as u, umamiEnv as v, PACKAGE_NAME as w, validateProjectName as x, updateFrontendLock as y, runningServices as z };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@django-stack/cli",
-  "version": "0.10.0",
-  "description": "The production-ready Django, batteries included stack. Create and manage DjangoStack projects: a Django backend, a frontend, Postgres and Docker Compose in one command.",
+  "version": "0.12.0",
+  "description": "The production-ready batteries included Django stack. Create and manage DjangoStack projects: a Django backend, a frontend, Postgres and Docker Compose in one command.",
   "license": "MIT",
   "author": "Leon van der Grient",
-  "homepage": "https://github.com/dwarsbit/django-stack/tree/main/packages/cli#readme",
+  "homepage": "https://djangostack.org/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dwarsbit/django-stack.git",

package/templates/backend/Dockerfile

@@ -10,9 +10,14 @@ ENV PYTHONDONTWRITEBYTECODE=1 \
     UV_PROJECT_ENVIRONMENT=/venv \
     PATH="/venv/bin:$PATH"
 COPY --from=ghcr.io/astral-sh/uv:0.11 /uv /bin/uv
-# The Postgres client, for the backups (pg_dump and pg_restore).
+# The Postgres client, for the backups (pg_dump and pg_restore), from the
+# PostgreSQL apt repository: its major version must match the server's, as
+# pg_dump refuses a newer server. Change it with the database.
+ARG POSTGRES_VERSION={{postgres_version}}
 RUN apt-get update \
-    && apt-get install --yes --no-install-recommends postgresql-client \
+    && apt-get install --yes --no-install-recommends postgresql-common \
+    && /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -y \
+    && apt-get install --yes --no-install-recommends "postgresql-client-${POSTGRES_VERSION}" \
     && rm -rf /var/lib/apt/lists/*
 RUN groupadd --system app && useradd --system --gid app --home-dir /app app
 WORKDIR /app

package/templates/backend/config/settings.py

@@ -42,6 +42,10 @@ INSTALLED_APPS = [
     "django_stack",
     "django_stack.contrib.captcha",  # the captcha of the contact form (CAPTCHA=off turns it off)
     "content",
+    # @if templates
+    "django_stack.contrib.site",  # preview, the page cache, redirects and the template tags of the site
+    "website",  # the site's pages
+    # @end
     # Last: builds the API routes once every model is exposed.
     "headless.rest",
 ]
@@ -56,6 +60,10 @@ MIDDLEWARE = [
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    # @if templates
+    # The redirects editors manage in the admin, for paths that do not exist.
+    "django_stack.contrib.site.middleware.RedirectMiddleware",
+    # @end
 ]
 
 ROOT_URLCONF = "config.urls"
@@ -72,6 +80,10 @@ TEMPLATES = [
                 "django.template.context_processors.request",
                 "django.contrib.auth.context_processors.auth",
                 "django.contrib.messages.context_processors.messages",
+                # @if templates
+                "django_stack.contrib.site.context_processors.site",  # preview, analytics_website_id
+                "website.context_processors.site",  # site, main_menu, footer_menu
+                # @end
             ],
         },
     },

package/templates/backend/config/studio.py

@@ -5,17 +5,30 @@ https://djangocontentstudio.org/docs/extensions for the hooks and extensions.
 """
 
 from content_studio.admin import ContentStudioSite
-from content_studio.analytics import AnalyticsExtension, AnalyticsLink, AnalyticsPage
+from content_studio.analytics import (
+    AnalyticsExtension,
+    AnalyticsLink,
+    AnalyticsPage,
+    AnalyticsStatisticWidget,
+    AnalyticsTopPagesWidget,
+)
 from content_studio.contrib.huey import HueyAdapter
-from content_studio.dashboard.tasks import TaskDashboard
+from content_studio.dashboard import Dashboard
+from content_studio.dashboard.activity_log import ActivityLogWidget
+from content_studio.dashboard.tasks import TaskDashboard, TaskStatisticWidget
 from content_studio.extensions import UserMenuLink
 from django_stack.analytics import UmamiProvider
 from django_stack.studio import SystemLink, SystemPage
 
+from content.dashboard import PublishedCountWidget, RecentSubmissionsWidget, SubmissionCountWidget
+from content.models import Page, Post
+
+TASKS = HueyAdapter()
+
 
 class SiteStudio(ContentStudioSite):
     extensions = [
-        TaskDashboard(adapter=HueyAdapter()),
+        TaskDashboard(adapter=TASKS),
         UserMenuLink(url="/tasks/", label="Tasks", icon="ph-bold ph-queue"),
         # Superusers only: the health checks and the latest error reports.
         SystemPage(),
@@ -29,5 +42,24 @@ class SiteStudio(ContentStudioSite):
     if UmamiProvider.is_configured():
         extensions += [AnalyticsExtension(provider=UmamiProvider()), AnalyticsPage(), AnalyticsLink()]
 
+    # The dashboard at /admin/: what the site has, what came in, what
+    # changed and how the worker is doing. The counters and the form
+    # submissions are in content/dashboard.py; change or remove them there.
+    dashboard = Dashboard(
+        widgets=[
+            PublishedCountWidget(Page, "Published pages", icon="ph-bold ph-file-text"),
+            PublishedCountWidget(Post, "Published posts", icon="ph-bold ph-article"),
+            SubmissionCountWidget(),
+            # Visitors and the most visited pages, with analytics on.
+            *([AnalyticsStatisticWidget("visitors", "30d")] if UmamiProvider.is_configured() else []),
+            RecentSubmissionsWidget(),
+            ActivityLogWidget(),
+            *([AnalyticsTopPagesWidget("30d")] if UmamiProvider.is_configured() else []),
+            # The task counts; the tasks themselves are on the Tasks page.
+            TaskStatisticWidget(TASKS, "queued"),
+            TaskStatisticWidget(TASKS, "failed"),
+        ]
+    )
+
 
 admin_site = SiteStudio()

package/templates/backend/config/urls.py

@@ -6,4 +6,15 @@ urlpatterns = [
     path("api/", include("headless.rest.urls")),
     path("", include("django_stack.urls")),  # /healthz and /readyz
     *media_urlpatterns(),  # uploaded files, in development only
+    # @if headless
+    path("", include("django_stack.start")),  # a start page with links to the admin and the API schema
+    # @end
+    # @if templates
+    path("", include("website.urls")),  # the site's pages, last: they include a catch-all for page paths
+    # @end
 ]
+# @if templates
+
+# The site's 404 page, with its layout (when DJANGO_DEBUG is off).
+handler404 = "website.views.not_found"
+# @end

package/templates/backend/content/admin.py

@@ -7,6 +7,7 @@ from content_studio import register
 from content_studio.admin import ModelStudio
 from content_studio.analytics import Analytics
 from content_studio.form import ActivityLog, Field, FormSet
+from django_stack.analytics import UmamiProvider
 from django_stack.studio import PreviewButton
 
 from .models import Author, Category, FormSubmission, Menu, Page, Post, Redirect, SiteSettings, Tag
@@ -17,9 +18,17 @@ POST_PREVIEW = PreviewButton(component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a02"
 PAGE_ACTIVITY = ActivityLog(component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a03")
 POST_ACTIVITY = ActivityLog(component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a04")
 # The visitors of the page or post, from the analytics (see config/studio.py).
-# Hidden while analytics are off.
-PAGE_ANALYTICS = Analytics(path_field="path", component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a05")
-POST_ANALYTICS = Analytics(path_field="slug", path_prefix="/blog/", component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a06")
+# Only with analytics on: Content Studio refuses them without its
+# AnalyticsExtension.
+ANALYTICS = UmamiProvider.is_configured()
+PAGE_ANALYTICS = (
+    [Analytics(path_field="path", component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a05")] if ANALYTICS else []
+)
+POST_ANALYTICS = (
+    [Analytics(path_field="slug", path_prefix="/blog/", component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a06")]
+    if ANALYTICS
+    else []
+)
 SEO = FormSet(
     title="Search and sharing",
     description="Leave empty to use the title and the site settings.",
@@ -42,7 +51,7 @@ class PageStudio(ModelStudio):
         FormSet(title="Body", fields=["body"]),
         SEO,
     ]
-    edit_sidebar = ["status", "published_at", PAGE_PREVIEW, "order", PAGE_ANALYTICS, PAGE_ACTIVITY]
+    edit_sidebar = ["status", "published_at", PAGE_PREVIEW, "order", *PAGE_ANALYTICS, PAGE_ACTIVITY]
 
 
 @register(Post)
@@ -67,7 +76,7 @@ class PostStudio(ModelStudio):
         "author",
         "categories",
         "tags",
-        POST_ANALYTICS,
+        *POST_ANALYTICS,
         POST_ACTIVITY,
     ]
 
@@ -115,7 +124,15 @@ class RedirectStudio(ModelStudio):
 
 @register(FormSubmission)
 class FormSubmissionStudio(ModelStudio):
+    """Submissions come from the site's form: editors read and delete them, never create or edit."""
+
     icon = "ph-bold ph-envelope"
     table_display = ["name", "email", "created_at"]
     search_fields = ["name", "email", "message"]
     ordering = ["-created_at"]
+
+    def has_add_permission(self, request, obj=None):
+        return False
+
+    def has_change_permission(self, request, obj=None):
+        return False

package/templates/backend/content/dashboard.py

@@ -0,0 +1,112 @@
+"""
+The widgets of the dashboard at /admin/: config/studio.py lists them. See
+https://djangocontentstudio.org/docs/dashboard for the widget types.
+"""
+
+from datetime import timedelta
+
+from content_studio.dashboard.content_list import ContentListWidget
+from content_studio.dashboard.statistic import StatisticWidget
+from content_studio.settings import cs_settings
+from django.db.models import Count
+from django.db.models.functions import TruncDate
+from django.utils import timezone
+from django.utils.text import Truncator
+from rest_framework.exceptions import PermissionDenied
+
+from .models import FormSubmission
+
+
+def check_view_permission(request, model):
+    """Widgets show only what the editor may view in the model's own list."""
+    studio = cs_settings.ADMIN_SITE._registry.get(model)
+    if studio is None or not studio.has_view_permission(request):
+        raise PermissionDenied()
+
+
+class PublishedCountWidget(StatisticWidget):
+    """The number of published objects of a model, with its drafts in the footnote."""
+
+    name = "PublishedCount"
+    refresh_interval = 300
+
+    def __init__(self, model, title: str, icon: str = "", widget_id=None):
+        self.model = model
+        self.title = title
+        self.icon = icon
+        super().__init__(widget_id)
+
+    def get_id_parts(self):
+        return (self.name, self.model._meta.label)
+
+    def get_data(self, request):
+        check_view_permission(request, self.model)
+        published = self.model.objects.published().count()
+        drafts = self.model.objects.filter(status=self.model.Status.DRAFT).count()
+        return {
+            "title": self.title,
+            "value": published,
+            "number_format": "full",
+            "icon": self.icon,
+            "footnote": f"{drafts} draft{'' if drafts == 1 else 's'}",
+        }
+
+
+class SubmissionCountWidget(StatisticWidget):
+    """The contact form submissions of the last 30 days, with one bar a day."""
+
+    name = "SubmissionCount"
+    refresh_interval = 300
+    days = 30
+
+    def get_data(self, request):
+        check_view_permission(request, FormSubmission)
+        today = timezone.localdate()
+        first = today - timedelta(days=self.days - 1)
+        per_day = dict(
+            FormSubmission.objects.filter(created_at__date__gte=first)
+            .annotate(day=TruncDate("created_at"))
+            .values("day")
+            .annotate(count=Count("pk"))
+            .values_list("day", "count")
+        )
+        series = [per_day.get(first + timedelta(days=offset), 0) for offset in range(self.days)]
+        return {
+            "title": "Form submissions",
+            "value": sum(series),
+            "number_format": "full",
+            "icon": "ph-bold ph-envelope-simple",
+            "footnote": f"Last {self.days} days",
+            "series": series,
+        }
+
+
+class RecentSubmissionsWidget(ContentListWidget):
+    """The latest contact form submissions, each linking to its page in the admin."""
+
+    name = "RecentSubmissions"
+    refresh_interval = 60
+    limit = 5
+
+    def get_data(self, request):
+        check_view_permission(request, FormSubmission)
+        latest = list(FormSubmission.objects.order_by("-created_at")[: self.limit])
+        return {
+            "title": "Recent form submissions",
+            "description": (
+                "The latest messages from the contact form."
+                if latest
+                else "No messages yet. Submissions from the contact form appear here."
+            ),
+            "view_all": f"/content/{FormSubmission._meta.label_lower}",
+            "content": [
+                {
+                    "model": FormSubmission._meta.label_lower,
+                    "id": str(submission.pk),
+                    "title": submission.name,
+                    "description": Truncator(submission.message).chars(120),
+                    "timestamp": submission.created_at,
+                }
+                for submission in latest
+            ],
+        }

package/templates/backend/content/seed.py

@@ -10,7 +10,7 @@ from content_studio.media_library.models import Media
 from django.core.files.base import ContentFile
 from django.db import transaction
 
-from .models import Author, Category, Menu, Page, Post, Redirect, SiteSettings, Tag
+from .models import Author, Category, FormSubmission, Menu, Page, Post, Redirect, SiteSettings, Tag
 
 
 def block(type: str, **data) -> dict:
@@ -141,6 +141,13 @@ def seed(if_empty: bool = False, stdout=None) -> bool:
         items=[block("link", label="RSS", url="/rss.xml")],
     )
     Redirect.objects.create(old_path="/old-about", new_path="/about")
+    # Messages of the contact form, so the dashboard has something to show.
+    FormSubmission.objects.bulk_create(
+        [
+            FormSubmission(name="Grace Reader", email="grace@example.com", message="Is there an RSS feed of the blog?"),
+            FormSubmission(name="Alan Visitor", email="alan@example.com", message="Hello from the contact page."),
+        ]
+    )
 
     settings = SiteSettings.objects.first() or SiteSettings()
     settings.site_name = "{{project_name}}"

package/templates/backend/content/tests/test_api.py

@@ -101,3 +101,18 @@ def test_contact_form_notifies_the_editors(seeded, django_capture_on_commit_call
 
 def test_read_key_cannot_read_submissions(reader):
     assert reader.get("/api/content.formsubmission").status_code == 403
+
+
+def test_editors_only_read_and_delete_submissions(rf):
+    from content_studio.admin import admin_site
+    from django.contrib.auth import get_user_model
+
+    from content.admin import FormSubmissionStudio
+
+    request = rf.get("/")
+    request.user = get_user_model().objects.create_superuser("editor", "editor@example.com", "x")
+    studio = FormSubmissionStudio(FormSubmission, admin_site)
+    assert studio.has_view_permission(request)
+    assert studio.has_delete_permission(request)
+    assert not studio.has_add_permission(request)
+    assert not studio.has_change_permission(request)