create-nuxt-base 0.3.17 → 1.0.3

package/.github/workflows/publish.yml

@@ -8,6 +8,10 @@ on:
 env:
   SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
 jobs:
   publish:
     runs-on: ubuntu-latest
@@ -26,8 +30,6 @@ jobs:
 
       - name: Publish to npm 🚀
         run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Deploy notification
         if: always()

package/.oxfmtrc.jsonc

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "arrowParens": "always",
+  "printWidth": 180,
+  "semi": true,
+  "singleQuote": true,
+}

package/CHANGELOG.md

@@ -2,35 +2,49 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.0.3](https://github.com/lenneTech/nuxt-base-starter/compare/v1.0.2...v1.0.3) (2026-01-12)
+
+### [1.0.2](https://github.com/lenneTech/nuxt-base-starter/compare/v1.0.1...v1.0.2) (2026-01-12)
+
+
+### Bug Fixes
+
+* add repository field in package.json ([1f43eae](https://github.com/lenneTech/nuxt-base-starter/commit/1f43eae4445b2f8a54cf4442c79be1bd55cf711c))
+
+### [1.0.1](https://github.com/lenneTech/nuxt-base-starter/compare/v1.0.0...v1.0.1) (2026-01-12)
+
+## [1.0.0](https://github.com/lenneTech/nuxt-base-starter/compare/v0.3.17...v1.0.0) (2026-01-12)
+
+
+### Bug Fixes
+
+* **DEV-609:** removed duplicate public folder inside app ([#10](https://github.com/lenneTech/nuxt-base-starter/issues/10)) ([25fe0fe](https://github.com/lenneTech/nuxt-base-starter/commit/25fe0fe3c53bc3400373d9c3f0a4b6705952171b))
+
 ### [0.3.17](https://github.com/lenneTech/nuxt-base-starter/compare/v0.3.16...v0.3.17) (2025-10-17)
 
 ### [0.3.16](https://github.com/lenneTech/nuxt-base-starter/compare/v0.3.15...v0.3.16) (2025-09-05)
 
-
 ### Bug Fixes
 
-* Update environment variable for bug feature toggle ([d875b3e](https://github.com/lenneTech/nuxt-base-starter/commit/d875b3eb586368499b9e628cdabd2f971e7cce7f))
+- Update environment variable for bug feature toggle ([d875b3e](https://github.com/lenneTech/nuxt-base-starter/commit/d875b3eb586368499b9e628cdabd2f971e7cce7f))
 
 ### [0.3.15](https://github.com/lenneTech/nuxt-base-starter/compare/v0.3.14...v0.3.15) (2025-09-05)
 
-
 ### Features
 
-* Add Linear API configuration and update dependencies ([291adfd](https://github.com/lenneTech/nuxt-base-starter/commit/291adfd8ee6e2c464c4b7c74e4c27531bda3892e))
+- Add Linear API configuration and update dependencies ([291adfd](https://github.com/lenneTech/nuxt-base-starter/commit/291adfd8ee6e2c464c4b7c74e4c27531bda3892e))
 
 ### [0.3.14](https://github.com/lenneTech/nuxt-base-starter/compare/v0.3.13...v0.3.14) (2025-08-01)
 
-
 ### Bug Fixes
 
-* **DEV-446:** Replace pnpm with npm for dependency installation and project commands ([8274c25](https://github.com/lenneTech/nuxt-base-starter/commit/8274c255384b841862d2d70a12c19ea30ecbb9d8))
+- **DEV-446:** Replace pnpm with npm for dependency installation and project commands ([8274c25](https://github.com/lenneTech/nuxt-base-starter/commit/8274c255384b841862d2d70a12c19ea30ecbb9d8))
 
 ### [0.3.13](https://github.com/lenneTech/nuxt-base-starter/compare/v0.3.12...v0.3.13) (2025-07-24)
 
-
 ### Bug Fixes
 
-* Update [@lenne](https://github.com/lenne).tech/nuxt-base dependency to latest version ([71dd666](https://github.com/lenneTech/nuxt-base-starter/commit/71dd6669fd9ec25671a102b4d2ad294ac88daa10))
+- Update [@lenne](https://github.com/lenne).tech/nuxt-base dependency to latest version ([71dd666](https://github.com/lenneTech/nuxt-base-starter/commit/71dd6669fd9ec25671a102b4d2ad294ac88daa10))
 
 ### [0.3.12](https://github.com/lenneTech/nuxt-base-starter/compare/v0.3.11...v0.3.12) (2025-07-24)
 

package/README.md

@@ -1,9 +1,136 @@
-# Nuxt Starter
+# create-nuxt-base
 
-This is a starter template to create a Nuxt 3 development environment including Tailwind, Pinia, VueUse, Nuxt Base, Eslint, Cypress with Cucumber, Unit Tests.
+A CLI tool to scaffold a production-ready **Nuxt 4** application with TypeScript, Tailwind CSS v4, NuxtUI v4, and modern tooling.
 
-Just run the following command to create your Nuxt environment:
+## Quick Start
 
 ```bash
 npx create-nuxt-base my-awesome-project
+cd my-awesome-project
+npm run dev
 ```
+
+The development server starts at **http://localhost:3001**
+
+## What's Included
+
+### Core Framework
+
+| Technology | Version | Description |
+|------------|---------|-------------|
+| Nuxt | 4.x | Vue 3 meta-framework with SSR support |
+| TypeScript | 5.9.x | Strict type checking enabled |
+| Tailwind CSS | 4.x | Utility-first CSS with Vite plugin |
+| NuxtUI | 4.x | Component library with dark mode |
+
+### Authentication (Better Auth)
+
+- Email/password authentication with client-side password hashing
+- Two-factor authentication (2FA/TOTP)
+- Passkey/WebAuthn support
+- Password reset flow
+- Pre-built auth pages: login, register, forgot-password, reset-password, 2fa
+
+### State & Data
+
+| Package | Purpose |
+|---------|---------|
+| Pinia | State management |
+| VueUse | Vue composition utilities |
+| @hey-api/client-fetch | Type-safe API client |
+| Valibot | Schema validation for forms |
+
+### SEO & Analytics
+
+- **@nuxtjs/seo** - Sitemap, robots.txt, OG images
+- **@nuxtjs/plausible** - Privacy-friendly analytics
+- **@nuxt/image** - Image optimization with IPX
+
+### Developer Experience
+
+| Tool | Purpose |
+|------|---------|
+| OxLint | Fast linting |
+| OxFmt | Code formatting |
+| Playwright | E2E testing |
+| @lenne.tech/bug.lt | Bug reporting to Linear (dev only) |
+| dayjs-nuxt | Date/time handling |
+
+### File Upload
+
+- TUS resumable upload support (`tus-js-client`)
+- Pre-built `TusFileUpload.vue` component
+
+### Docker Support
+
+- `Dockerfile.dev` for containerized development
+- Hot reload enabled
+
+## Project Structure
+
+```
+my-project/
+├── app/
+│   ├── assets/css/       # Tailwind CSS
+│   ├── components/       # Vue components (auto-imported)
+│   │   ├── Modal/        # Modal components
+│   │   ├── Transition/   # Transition components
+│   │   └── Upload/       # File upload components
+│   ├── composables/      # Composables (auto-imported)
+│   ├── interfaces/       # TypeScript interfaces
+│   ├── layouts/          # Nuxt layouts
+│   ├── lib/              # Auth client configuration
+│   ├── middleware/       # Route middleware (auth, admin, guest)
+│   ├── pages/            # File-based routing
+│   │   ├── auth/         # Authentication pages
+│   │   └── app/          # Protected app pages
+│   ├── utils/            # Utility functions
+│   └── app.config.ts     # NuxtUI configuration
+├── docs/                 # Dev-only documentation layer
+├── tests/                # Playwright E2E tests
+├── nuxt.config.ts        # Nuxt configuration
+├── openapi-ts.config.ts  # API type generation config
+└── playwright.config.ts  # E2E test configuration
+```
+
+## Available Scripts
+
+| Script | Description |
+|--------|-------------|
+| `npm run dev` | Start development server |
+| `npm run build` | Build for production |
+| `npm run preview` | Preview production build |
+| `npm run generate-types` | Generate TypeScript types from OpenAPI |
+| `npm run test` | Run Playwright E2E tests |
+| `npm run lint` | Run OxLint |
+| `npm run format` | Run OxFmt |
+| `npm run check` | Run lint + format check |
+| `npm run fix` | Auto-fix lint + format issues |
+
+## Environment Variables
+
+Create a `.env` file based on `.env.example`:
+
+```env
+# Required
+SITE_URL=http://localhost:3001
+API_URL=http://localhost:3000
+APP_ENV=development
+NODE_ENV=development
+
+# Optional
+WEB_PUSH_KEY=                # Web push notifications
+LINEAR_API_KEY=              # Bug reporting
+LINEAR_TEAM_NAME=            # Bug reporting
+LINEAR_PROJECT_NAME=         # Bug reporting
+STORAGE_PREFIX=base-dev      # Local storage prefix
+```
+
+## Requirements
+
+- Node.js >= 22
+- npm >= 10
+
+## License
+
+MIT

package/nuxt-base-template/.dockerignore

@@ -0,0 +1,44 @@
+# Dependencies
+node_modules
+.npm
+
+# Build output
+.nuxt
+.output
+dist
+
+# IDE
+.idea
+.vscode
+*.swp
+*.swo
+
+# Logs
+*.log
+npm-debug.log*
+
+# Testing
+coverage
+test-results
+playwright-report
+
+# Environment
+.env.local
+.env.*.local
+
+# Git
+.git
+.gitignore
+
+# Docker
+Dockerfile*
+docker-compose*
+.dockerignore
+
+# Documentation
+*.md
+!README.md
+
+# Misc
+.DS_Store
+*.tgz

package/nuxt-base-template/.env.example

@@ -3,9 +3,7 @@ APP_ENV=development
 NODE_ENV=development
 API_URL=http://localhost:3000
 WEB_PUSH_KEY=
-API_SCHEMA=../api/schema.gql
 STORAGE_PREFIX=base-dev
-GENERATE_TYPES=0
 
 LINEAR_API_KEY=
 LINEAR_TEAM_NAME=

package/nuxt-base-template/.nuxtrc

@@ -0,0 +1 @@
+setups.@nuxt/test-utils="3.23.0"

package/nuxt-base-template/.oxfmtrc.jsonc

@@ -0,0 +1,8 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "arrowParens": "always",
+  "printWidth": 180,
+  "semi": true,
+  "singleQuote": true,
+  "ignorePatterns": [".nuxt", ".output", "node_modules", "dist"],
+}

package/nuxt-base-template/Dockerfile.dev

@@ -0,0 +1,23 @@
+FROM node:22-alpine
+
+WORKDIR /app
+
+# Install dependencies for native modules
+RUN apk add --no-cache python3 make g++
+
+# Copy package files first for better caching
+COPY package*.json ./
+COPY .npmrc ./
+
+# Install dependencies
+RUN npm ci
+
+# Copy entrypoint script
+COPY docker-entrypoint.sh /docker-entrypoint.sh
+RUN chmod +x /docker-entrypoint.sh
+
+# Expose port
+EXPOSE 3001
+
+ENTRYPOINT ["/docker-entrypoint.sh"]
+CMD ["npm", "run", "dev", "--", "--host", "0.0.0.0"]

package/nuxt-base-template/README.md

@@ -1,6 +1,6 @@
 # Nuxt Base Template
 
-A modern Nuxt 4 SSR starter template with TypeScript, Tailwind CSS v4, and NuxtUI.
+A production-ready Nuxt 4 SSR starter with TypeScript, Tailwind CSS v4, NuxtUI v4, and Better Auth.
 
 ## Requirements
 
@@ -33,6 +33,13 @@ Start the development server on http://localhost:3001
 npm run dev
 ```
 
+### Docker Development
+
+```bash
+docker build -f Dockerfile.dev -t nuxt-app-dev .
+docker run -p 3001:3001 -v $(pwd):/app nuxt-app-dev
+```
+
 ## Production
 
 Build the application for production:
@@ -62,8 +69,8 @@ Run linting and formatting checks before committing:
 ```bash
 npm run check           # Run lint + format check
 npm run fix             # Auto-fix lint + format issues
-npm run lint            # ESLint only
-npm run format          # Prettier format only
+npm run lint            # OxLint only
+npm run format          # OxFmt format only
 ```
 
 ## Testing
@@ -84,33 +91,64 @@ npm run generate-types
 
 ## Tech Stack
 
-- **Framework:** Nuxt 4.1.3 (Vue 3 Composition API)
-- **Language:** TypeScript 5.9.3
-- **Styling:** Tailwind CSS 4.1.14
-- **UI Library:** NuxtUI 4.0.1
-- **State Management:** Pinia
-- **Testing:** Playwright
-- **API Client:** @hey-api/client-fetch
-- **Form Validation:** Valibot
+| Technology | Version | Description |
+|------------|---------|-------------|
+| Nuxt | 4.2.x | Vue 3 meta-framework with SSR |
+| TypeScript | 5.9.x | Strict type checking |
+| Tailwind CSS | 4.1.x | Utility-first CSS (Vite plugin) |
+| NuxtUI | 4.3.x | Component library with dark mode |
+| Pinia | 0.11.x | State management |
+| Better Auth | 1.4.x | Authentication framework |
+| Playwright | 1.57.x | E2E testing |
+| @hey-api/client-fetch | 0.13.x | Type-safe API client |
+| Valibot | 1.2.x | Schema validation |
 
 ## Key Features
 
-- ✅ Full TypeScript support with strict typing
-- ✅ NuxtUI component library with semantic colors
-- ✅ Dark/light mode support
-- ✅ SEO optimization (sitemap, robots.txt, OG images)
-- ✅ Auto-generated API client from OpenAPI schema
-- ✅ E2E testing with Playwright
-- ✅ ESLint + Prettier configuration
-- ✅ Plausible Analytics integration
-- ✅ Image optimization with NuxtImage
-- ✅ Bug reporting to Linear (dev only)
+### Authentication (Better Auth)
+
+- Email/password authentication with client-side SHA256 password hashing
+- Two-factor authentication (2FA/TOTP) with backup codes
+- Passkey/WebAuthn support
+- Password reset flow
+- Pre-built pages: login, register, forgot-password, reset-password, 2fa
+- Route middleware: `auth.global.ts`, `admin.global.ts`, `guest.global.ts`
+
+### UI & Styling
+
+- NuxtUI v4 component library
+- Dark/light mode support
+- Transition components (Fade, Slide, FadeScale)
+- Modal components with `useOverlay` pattern
+
+### SEO & Analytics
+
+- Sitemap generation (`@nuxtjs/seo`)
+- robots.txt configuration
+- OG image generation
+- Plausible Analytics integration
+
+### File Upload
+
+- TUS resumable uploads (`tus-js-client`)
+- Pre-built `TusFileUpload.vue` component
+- Progress tracking and error handling
+
+### Developer Experience
+
+- OxLint for fast linting
+- OxFmt for code formatting
+- Auto-generated API client from OpenAPI
+- Bug reporting to Linear (dev only via `@lenne.tech/bug.lt`)
+- VueUse composition utilities
+- dayjs for date/time handling
 
 ## Environment Variables
 
 Create a `.env` file with the following variables:
 
 ```env
+# Required
 SITE_URL=http://localhost:3001
 API_URL=http://localhost:3000
 APP_ENV=development
@@ -124,7 +162,7 @@ WEB_PUSH_KEY=                # Web push notifications
 LINEAR_API_KEY=              # Bug reporting
 LINEAR_TEAM_NAME=            # Bug reporting
 LINEAR_PROJECT_NAME=         # Bug reporting
-API_SCHEMA=../api/schema.gql # API schema path
+API_SCHEMA=../api/schema.gql # OpenAPI schema path
 STORAGE_PREFIX=base-dev      # Local storage prefix
 ```
 
@@ -132,25 +170,34 @@ STORAGE_PREFIX=base-dev      # Local storage prefix
 
 ```
 app/
-├── assets/          # Tailwind CSS configuration
+├── assets/css/      # Tailwind CSS styles
 ├── components/      # Vue components (auto-imported)
+│   ├── Modal/       # Modal components
+│   ├── Transition/  # Transition animations
+│   └── Upload/      # File upload components
 ├── composables/     # Composables (auto-imported)
-├── interfaces/      # TypeScript interfaces (auto-imported)
-├── layouts/         # Nuxt layouts
+│   ├── use-better-auth.ts   # Auth session helpers
+│   ├── use-file.ts          # File utilities
+│   ├── use-share.ts         # Share API
+│   └── use-tus-upload.ts    # TUS upload logic
+├── interfaces/      # TypeScript interfaces
+├── layouts/         # Nuxt layouts (default, slim)
+├── lib/             # Auth client configuration
+├── middleware/      # Route guards (auth, admin, guest)
 ├── pages/           # File-based routing
+│   ├── auth/        # Authentication pages
+│   └── app/         # Protected app pages
+├── utils/           # Utility functions
 └── app.config.ts    # NuxtUI configuration
 
 docs/                # Dev-only documentation layer
 tests/               # Playwright E2E tests
 ```
 
-## Development Guidelines
-
-For detailed coding standards and architecture information, see [CLAUDE.md](./CLAUDE.md).
-
 ## Documentation
 
 - [Nuxt Documentation](https://nuxt.com/docs)
 - [NuxtUI Documentation](https://ui.nuxt.com)
+- [Better Auth Documentation](https://www.better-auth.com)
 - [Tailwind CSS Documentation](https://tailwindcss.com/docs)
 - [Vue 3 Documentation](https://vuejs.org)

package/nuxt-base-template/app/components/Modal/ModalBackupCodes.vue

@@ -0,0 +1,117 @@
+<script lang="ts" setup>
+// ============================================================================
+// Imports
+// ============================================================================
+import type { FormSubmitEvent } from '@nuxt/ui';
+import type { InferOutput } from 'valibot';
+
+import * as v from 'valibot';
+
+import { authClient } from '~/lib/auth-client';
+
+// ============================================================================
+// Props & Emits
+// ============================================================================
+interface Props {
+  initialCodes?: string[];
+}
+
+const props = withDefaults(defineProps<Props>(), {
+  initialCodes: () => [],
+});
+
+const emit = defineEmits<{
+  close: [result?: unknown];
+}>();
+
+// ============================================================================
+// Composables
+// ============================================================================
+const toast = useToast();
+
+// ============================================================================
+// Variables
+// ============================================================================
+const loading = ref<boolean>(false);
+const backupCodes = ref<string[]>(props.initialCodes);
+
+const passwordSchema = v.object({
+  password: v.pipe(v.string('Passwort ist erforderlich'), v.minLength(1, 'Passwort ist erforderlich')),
+});
+
+type PasswordSchema = InferOutput<typeof passwordSchema>;
+
+// ============================================================================
+// Functions
+// ============================================================================
+function copyBackupCodes(): void {
+  navigator.clipboard.writeText(backupCodes.value.join('\n'));
+  toast.add({
+    color: 'success',
+    description: 'Backup-Codes wurden in die Zwischenablage kopiert',
+    title: 'Kopiert',
+  });
+}
+
+async function generateBackupCodes(payload: FormSubmitEvent<PasswordSchema>): Promise<void> {
+  loading.value = true;
+
+  try {
+    const { data, error } = await authClient.twoFactor.generateBackupCodes({
+      password: payload.data.password,
+    });
+
+    if (error) {
+      toast.add({
+        color: 'error',
+        description: error.message || 'Backup-Codes konnten nicht generiert werden',
+        title: 'Fehler',
+      });
+      return;
+    }
+
+    backupCodes.value = data?.backupCodes ?? [];
+  } finally {
+    loading.value = false;
+  }
+}
+
+function handleClose(): void {
+  emit('close');
+}
+</script>
+
+<template>
+  <UModal title="Backup-Codes" :close="{ onClick: handleClose }">
+    <template #body>
+      <div class="space-y-4">
+        <div class="flex items-center gap-3">
+          <UIcon name="i-lucide-key" class="size-6 text-warning" />
+          <p class="text-sm text-muted">Bewahre diese Codes sicher auf. Jeder Code kann nur einmal verwendet werden.</p>
+        </div>
+
+        <template v-if="backupCodes.length > 0">
+          <div class="grid grid-cols-2 gap-2 rounded-lg bg-muted/50 p-4 font-mono text-sm">
+            <span v-for="code in backupCodes" :key="code">{{ code }}</span>
+          </div>
+        </template>
+
+        <template v-else>
+          <UForm :schema="passwordSchema" class="space-y-4" @submit="generateBackupCodes">
+            <UFormField label="Passwort" name="password">
+              <UInput name="password" type="password" placeholder="Dein Passwort" />
+            </UFormField>
+            <UButton type="submit" block :loading="loading"> Neue Backup-Codes generieren </UButton>
+          </UForm>
+        </template>
+      </div>
+    </template>
+
+    <template #footer>
+      <div class="flex justify-end gap-3">
+        <UButton v-if="backupCodes.length > 0" variant="outline" icon="i-lucide-copy" @click="copyBackupCodes"> Codes kopieren </UButton>
+        <UButton color="neutral" variant="outline" @click="handleClose"> Schließen </UButton>
+      </div>
+    </template>
+  </UModal>
+</template>