Nuxt 3 Boilerplate

A modern, feature-rich Nuxt 3 starter template with TypeScript support, Nuxt UI, state management with Pinia, and comprehensive tooling for development.

Features

• ⚡️ Nuxt 3 with pnpm - super fast development and build times
• 🎨 Nuxt UI - sophisticated, accessible, and highly performant user interfaces
• 🔍 TypeScript - type safety and improved developer experience
• 📝 NuxtFonts - plug-and-play fonts optimization
• 🍍 Pinia - intuitive, type safe store for Vue
• 📱 Device Detection - mobile and device detection (@nuxtjs/device)
• ✨ Eslint Nuxt - code quality and consistency
• 🐕 Husky & Lint-staged - Git hooks for code quality
• 🖼️ Nuxt Image - optimized image handling
• 🚀 Nuxt Icons - easy icon usage
• 🧩 Custom error page with consistent UI

Project Structure

├── eslint.config.mjs  # ESLint configuration
├── LICENSE            # License file
├── nuxt.config.ts     # Nuxt configuration
├── package.json       # Project dependencies
├── pnpm-lock.yaml     # pnpm lock file
├── README.md          # Project documentation
├── tsconfig.json      # TypeScript configuration
├── app/               # Main application directory
│   ├── app.vue        # Application entry point
│   ├── error.vue      # Error page
│   ├── assets/        # Static assets
│   │   └── css/       # CSS files
│   │       └── main.css
│   ├── components/    # Vue components
│   │   ├── AppFooter.vue
│   │   ├── AppNavBar.vue
│   │   ├── AppTitle.vue
│   │   ├── ProductCard.vue
│   │   └── QuickAccess.vue
│   ├── layouts/       # Page layouts
│   │   └── default.vue
│   ├── pages/         # Application routes
│   │   ├── index.vue
│   │   └── play.vue
│   ├── store/         # Pinia store modules
│   │   └── productStore.ts
│   └── types/         # TypeScript type definitions
│       └── index.ts
└── public/            # Public static assets
    └── favicon.ico

Setup

Make sure to install the dependencies:

# Install dependencies
pnpm install

Development

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

pnpm dev

Production

Build the application for production:

pnpm build

Locally preview production build:

pnpm preview

Linting

Run linting:

pnpm lint

Fix linting issues:

pnpm lintfix

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License.

Check out the Nuxt 3 documentation for more information.