@michaelthielemann/kestrel 1.2.1 → 1.3.0

package/templates/starter/_env.example

@@ -0,0 +1,17 @@
+# Auth/session is env-only — secrets never belong in a committed config file. `.env.example` is the
+# committed copy of this template; `.env` holds the real values and is gitignored.
+#
+# The two below are read per request. Every other KESTREL_* var is read once when the app is BUILT
+# (dev start / build / generate) and frozen into runtimeConfig — see docs/configuration.md.
+
+# Session signing secret, >= 32 bytes. Required in production. Generate: kestrel secret
+KESTREL_SESSION_SECRET=
+
+# Admin password hash. Without it /admin renders but sign-in answers 503. Generate: kestrel hash-password
+KESTREL_ADMIN_PASSWORD_HASH=
+
+# Drops the __Host- cookie prefix and the Secure flag. Plain-HTTP localhost ONLY; rejected in production.
+KESTREL_SECURE_COOKIES=false
+
+# Optional: session lifetime in seconds (default 604800 = 7 days)
+# KESTREL_SESSION_MAX_AGE=604800

package/templates/starter/_gitignore

@@ -0,0 +1,26 @@
+# Dependencies
+node_modules
+
+# Nuxt / Nitro build output
+.nuxt
+.nitro
+.cache
+.output
+dist
+
+# Secrets
+.env
+.env.*
+!.env.example
+
+# Runtime database, uploads and published output
+.data
+*.sqlite
+*.sqlite-shm
+*.sqlite-wal
+
+# Logs
+*.log
+
+# OS / editor
+.DS_Store

package/templates/starter/_package.json

@@ -0,0 +1,22 @@
+{
+  "name": "{{name}}",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "nuxt dev",
+    "build": "nuxt build",
+    "preview": "nuxt preview",
+    "generate": "nuxt generate",
+    "typecheck": "nuxt prepare && nuxt typecheck && tsc -p .nuxt/tsconfig.server.json --noEmit",
+    "hash-password": "kestrel hash-password",
+    "doctor": "kestrel doctor"
+  },
+  "dependencies": {
+    "@michaelthielemann/kestrel": "{{version}}"
+  },
+  "devDependencies": {
+    "nuxt": "{{nuxtVersion}}",
+    "typescript": "{{typescriptVersion}}",
+    "vue-tsc": "{{vueTscVersion}}"
+  }
+}

package/templates/starter/app/app.vue

@@ -0,0 +1,7 @@
+<template>
+  <!-- Both wrappers are load-bearing: without <NuxtPage /> no route renders, without <NuxtLayout /> the
+       admin loses its shell. Delete this file to fall back to the one Kestrel ships. -->
+  <NuxtLayout>
+    <NuxtPage />
+  </NuxtLayout>
+</template>

package/templates/starter/app/blocks/Prose.vue

@@ -0,0 +1,12 @@
+<script setup lang="ts">
+// One SFC is one block type: the filename names it, defineProps is its schema. Add a sibling to add one.
+defineProps({
+  body: richtextField({ required: true }),
+})
+defineBlock({ label: { en: 'Prose' }, icon: 'file-text' })
+</script>
+
+<template>
+  <!-- richtext is sanitized server-side on write -->
+  <div class="block-prose" v-html="body" />
+</template>

package/templates/starter/app/layouts/default.vue

@@ -0,0 +1,6 @@
+<template>
+  <!-- The public site's frame. The admin uses its own layout and is unaffected by anything here. -->
+  <main>
+    <slot />
+  </main>
+</template>

package/templates/starter/nuxt.config.ts

@@ -0,0 +1,20 @@
+export default defineNuxtConfig({
+  compatibilityDate: '2026-06-02',
+  future: { compatibilityVersion: 4 },
+  // This one line composes the whole CMS. Opt-in extension layers go after it.
+  extends: ['@michaelthielemann/kestrel'],
+  // Not inherited from an extended layer, so it has to be repeated here.
+  typescript: { tsConfig: { compilerOptions: { noUncheckedIndexedAccess: false } } },
+  nitro: { typescript: { tsConfig: { compilerOptions: { noUncheckedIndexedAccess: false } } } },
+  // Auth/session is env-only, see `.env`. Every key here is optional.
+  kestrel: {
+    db: '.data/db.sqlite',
+    // Baked into canonical URLs, hreflang, sitemap.xml and llms.txt at build time. Set it to the public
+    // origin before the first real deploy — or leave it to KESTREL_SITE_URL per environment.
+    siteUrl: 'http://localhost:3000',
+    siteName: '{{name}}',
+    media: { uploadDir: '.data/uploads' },
+    // locales: ['en', 'de'],
+    // collections: { pages: false },
+  },
+})

package/templates/starter/pnpm-workspace.yaml

@@ -0,0 +1,8 @@
+# pnpm blocks dependency build scripts unless they are listed here, and Kestrel's SQLite driver and image
+# pipeline are native — without this `pnpm install` completes but the app cannot start. Delete this file
+# if you use npm or yarn. (`pnpm.onlyBuiltDependencies` in package.json is silently ignored on pnpm 11.)
+allowBuilds:
+  '@parcel/watcher': true
+  better-sqlite3: true
+  esbuild: true
+  sharp: true

package/templates/starter/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./.nuxt/tsconfig.json"
+}