Skip to content

This is a boilerplate project for Nuxt 3, designed to jumpstart your development with a robust setup featuring PrimeVue for UI components, enhanced security best practices, and SEO optimization. Whether you're building a new web application or looking to improve an existing project, this template provides a solid foundation.

Notifications You must be signed in to change notification settings

tajalaoui/nuxt-boilerplate

Repository files navigation

Nuxt Boilerplate Project

This is a boilerplate project setup for a Nuxt.js application with various integrated modules and security best practices.

Features

  • PrimeVue: For UI components with auto-import and ripple effects.
  • Tailwind CSS: For utility-first CSS styling.
  • Nuxt Image: For optimized image handling.
  • Nuxt Security: For security headers and practices.
  • Nuxt i18n: For internationalization and localization.
  • Nuxt SEO: For SEO optimization.
  • VueUse: For useful Vue composition API utilities.
  • Nuxt Booster: For performance enhancements.
  • Nuxt Icons: For icon management.

Configuration

nuxt.config.js

This file contains the configuration for the Nuxt.js application. Here are the key sections:

  • Modules: Integrates various Nuxt.js modules such as @primevue/nuxt-module, @nuxtjs/tailwindcss, @nuxt/fonts, @nuxt/image, and others.
  • PrimeVue: Configures PrimeVue with auto-import, ripple effects, and the Aura theme.
  • CSS: Includes global CSS files, such as PrimeIcons and Tailwind CSS.
  • Image: Sets the image quality to 80%.
  • Site: Configures basic site information like URL, name, and description.
  • i18n: Configures internationalization with lazy loading of locales and browser language detection.
  • Security: Configures security headers with a cross-origin embedder policy based on the environment.

Setup

Make sure to install the dependencies:

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install

Development Server

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

# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

# bun
bun run dev

Production

Build the application for production:

# npm
npm run build

# pnpm
pnpm run build

# yarn
yarn build

# bun
bun run build

Locally preview production build:

# npm
npm run preview

# pnpm
pnpm run preview

# yarn
yarn preview

# bun
bun run preview

Check out the deployment documentation for more information.

About

This is a boilerplate project for Nuxt 3, designed to jumpstart your development with a robust setup featuring PrimeVue for UI components, enhanced security best practices, and SEO optimization. Whether you're building a new web application or looking to improve an existing project, this template provides a solid foundation.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages