Nuxt Core Starter Template

This project serves as a core starter template for Nuxt-based applications. Use this as a foundation for future projects to ensure a consistent, modern, and maintainable setup.

Project Purpose

This repository is designed to be cloned or forked as the starting point for any new Nuxt project. It includes essential tools, configurations, and best practices for rapid development.

Included Packages & Why

• nuxt: The main framework for building Vue-based applications with SSR, SSG, and more.
• vue & vue-router: Core Vue 3 and routing support (managed by Nuxt).
• @nuxt/eslint: Integrates ESLint for code quality and consistency.
• @antfu/eslint-config: Opinionated ESLint config for modern JS/TS/Vue projects.
• eslint & plugins: Linting and formatting support.
• @nuxt/icon: Easy icon usage in your app (see <Icon name="..." /> usage in app.vue).
• @iconify-json/tabler: Icon set for use with the icon module.
• tailwindcss: Utility-first CSS framework for rapid UI development.
• @tailwindcss/vite: Tailwind integration for Vite (Nuxt's underlying build tool).
• daisyui: Tailwind CSS component library for beautiful, ready-to-use UI elements.
• typescript: Type safety and improved developer experience.
• husky & lint-staged: Git hooks for enforcing code quality before commits.

Key Configuration & Settings

• nuxt.config.ts
  • Loads TailwindCSS and DaisyUI via assets/css/main.css.
  • Enables ESLint integration and custom rules.
  • Adds @nuxt/icon for icon support.
  • Vite plugins configured for Tailwind.
• eslint.config.mjs
  • Uses Antfu's config for best practices.
  • Custom rules for Vue, TypeScript, and formatting.
• TypeScript
  • Project is TypeScript-ready, extending Nuxt's recommended configs.
• assets/css/main.css
  • Imports TailwindCSS and DaisyUI, with light/dark theme support.
• husky & lint-staged
  • Ensures code is linted before every commit.
• /.vscode
  • Extension recommendations and Antfu's vscode settings.

Usage

Install dependencies

pnpm install

Development

pnpm dev

Visit [http://localhost:3000]

Production

pnpm build
pnpm preview

Extending This Template

• Add new pages/components in the standard Nuxt way.
• Update assets/css/main.css to customize Tailwind/DaisyUI themes.
• Adjust ESLint rules in eslint.config.mjs as needed.
• Add more Nuxt modules or plugins as your project grows.

References

• Nuxt Documentation
• Nuxt Icon Module
• Nuxt Eslint Module
• TailwindCSS
• DaisyUI
• Husky
• lint-staged
• antfu-eslin-config
• Icons Dataset

---

This template is designed for maintainability and scalability. Use it as your base for all future Nuxt projects!