Nuxt 3 Starter

A Nuxt 3 starter template with Tailwind CSS, Headless UI, Pinia, Vueuse, Formkit, Google Fonts, Eslint, Prettier, Husky, Commitlint, and more.

WARNING: This Project using "pnpm" as package manager. (not npm or yarn)!!!

Checkout Nuxt 3 documentation for more information.

Features

• TypeScript enabled
• Tailwind CSS v3 (@nuxtjs/tailwindcss)
• Headless UI (nuxt-headlessui)
• State & Store Management (@pinia/nuxt)
• Vue Composition Collection (@vueuse/nuxt)
• Google Fonts (prelease)
• Forms (@formkit/nuxt)
• Icons: Heroicons and Nuxt Icons
• Eslint & Prettier
• Husky & Commitlint

TODO

• Testing (Nuxt Testing)
• Authentication (sidebase/nuxt-auth)
• Internationalization (Nuxt I18n)
• Color Mode (Nuxt Color Mode)
• Content (Nuxt Content)

Structure

.
├── .husky
│   ├── commit-msg
│   ├── post-merge
│   └── pre-commit
├── .vscode
│   ├── extensions.json
│   ├── settings.json
│   └── vue.code-snippets
│   ├── src
│   ├── assets
│   │   └── css
│   │   │   └── tailwind.css
│   │   └──  icons
│   ├── components
│   │   ├── atoms
│   │   ├── molecules
│   │   └── organisms
│   ├── composables
│   ├── layouts
│   │   └── default.vue
│   ├── modules
│   ├── pages
│   │   └── index.vue
│   ├── public
│   │   └── favicon.ico
│   ├── stores
│   └── app.vue
├── nuxt.config.ts
├── formkit.config.ts
├── tailwind.config.ts
├── tsconfig.json
├── package.json
├── pnpm-lock.yaml
├── .env
├── .npmrc
├── .gitignore
├── .commitlintrc.yml
├── .eslintrc.yml
├── .prettierrc.yml
├── .stylelintrc.yml
├── .tool-versions
├── .editorconfig
├── README.md
└── LICENSE.md

Setup

Clone the repository:

pnpm dlx nuxi init <project-name> -t gh:mukundshah/nuxt3-starter

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 run preview

Check out the nuxt deployment documentation for more information.

License

MIT License

Atribution

This template was inspired by viandwi24/nuxt3-awesome-starter.