Opinionated Nuxt Starter Template

Nuxt Modules

• Nuxt UI - A UI Library for Modern Web Apps.
• VueUse - Collection of Vue Composition Utilities.
• Reka UI - Craft accessible web apps with Vue.
• Content - Content made easy for Vue Developers.
• Image - Plug-and-play image optimization for Nuxt apps.
• ESLint - Find and fix problems in your JavaScript code.
• Hints - DevTools hints for performance, hydration, security, and more.

These are the pre-packed modules in this starter template. Feel free to ditch any module you won't be using.

Nuxt UI Modules

These modules are pre-packed with the Nuxt UI module.

• TailwindCSS - Rapidly build modern websites without ever leaving your HTML.
• Color mode - Dark and Light mode with auto-detection made easy with Nuxt 🌗.
• Icon - Icon module for Nuxt with 100,000+ ready to use icons from Iconify.
• Fonts - Plug-and-play web font optimization and configuration for Nuxt apps.

Zod is mainly included for schema validation in UForm (see here).

Out-of-the-Box Features

• API Client: Pre-configured $api client and plugin for standardized fetch requests.
• Environment Validation: Fail-fast validation of environment variables on startup.
• Custom Logger: Centralized useLogger utility for structured logs.
• Hydration Flag: Client hydration flag plugin helper.
• Auth Scaffolding: Built-in auth layouts, login pages, and session middleware.

Other Features

• pnpm - Save time. Save disk space. Supercharge your monorepos.
• Prettier - Opinionated code formatter.
  • prettier-plugin-tailwindcss - Automatic Class Sorting with Prettier. Read more.
• Unlighthouse - Lighthouse for your entire site.
• TypeScript - JavaScript with syntax for types.

Setup

Make sure to install the dependencies:

pnpm install

Development Server

Start the development server on http://localhost:3000

pnpm dev

Production

Build the application for production:

pnpm build

Locally preview production build:

pnpm preview

Check out the deployment documentation for more information.

Checklist

When you use this template, try to follow the checklist to update your info properly

• Copy .env.example to .env and configure environment variables
• Change the name and description in package.json
• Change the author name in LICENSE
• Remove <NuxtWelcome /> in src/pages/index.vue
• Clean up the READMEs and remove routes
• Clean up the images in public/
• Remove any modules you won't be needing.