lio-zero / nuxt3-starter

A Better Nuxt 3 Starter Template

Nuxt 3 Starter

WARNING：Nuxt 3 now in RC version. Not recommended for production use.

Check out the Nuxt 3 roadmap

First, learn how Nuxt 3 works.

Tips: @nuxtjs/i18n is unstable, the project is not working for the time being, if you need an i18N replacement, you can use @intlify/nuxt3

reference: vitesse-nuxt3.

Preview

Features

• 💚 Nuxt 3 - SSR, ESR, File-based routing, components auto importing, modules, etc.
• ⚡️ Vite - Instant HMR
• 🎨 UnoCSS - The instant on-demand atomic CSS engine.
• 😃 Use icons from any icon sets in Pure CSS, powered by UnoCSS
• 🔥 The <script setup> syntax
• 🍍 State Management via Pinia
• 📑 Layout system
• 📥 APIs auto importing - for Composition API, VueUse and custom composables.
• 🏎 Zero-config cloud functions and deploy
• 🦾 TypeScript, of course

Plugins

• 🎨 @unocss/nuxt - Nuxt module for UnoCSS
• 🤹 unplugin-icons - Use icons from any iconsets
• 🍍 @pinia/nuxt - Using Pinia with Nuxt 3
• 🌍 @nuxtjs/i18n - Nuxt 3 Module for vue-i18n-next
• 🛠️ @vueuse/nuxt3 - This is an add-on of VueUse, which provides better Nuxt integration auto-import capabilities.

IDE

We recommend using VS Code with Volar to get the best experience (You might want to disable Vetur if you have it).

Coding Style

ESLint with @antfu/eslint-config, single quotes, no semi.

Use husky and lint-staged to verify the code before submission.

The following specifications are not considered by the authors and are left to your own choice:

• prettier
• commitlint
• stylelint
• commitizen

Try it now

Nuxt3-starter requires Node >=14.18

GitHub Template

Create a repo from this template on GitHub.

Clone to local

If you prefer to do it manually with the cleaner git history:

npx degit lio-zero/nuxt3-starter my-nuxt3-app
cd my-nuxt3-starter
pnpm i --shamefully-hoist # If you don't have pnpm installed, run: npm install -g pnpm

Or nuxi:

npx nuxi init -t lio-zero/nuxt3-starter my-nuxt3-app

 ✨ Your solid Nuxt project is just created! Next steps:
 📁  cd my-nuxt3-app
 💿  Install dependencies with `npm install` or `yarn install` or `pnpm install -shamefully-hoist`
 🚀  Start development server with `npm run dev` or `yarn dev` or `pnpm run dev`

Usage

Development Server

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

pnpm dev

Production Server

Build the application for production:

pnpm run build

Locally preview production build:

pnpm run preview

Checkout the deployment documentation for more information.

License

MIT @lio-zero