Nuxt3 NuxtUI Starter

What is Nuxt 3 + NuxtUI + Codestyle Starter?

The Nuxt 3 + NuxtUI + Codestyle Starter is a boilerplate template that scaffolds a Nuxt 3 application with the NuxtUI component library and a pre-configured code quality toolbox covering ESLint, Prettier, and Stylelint. It takes a development machine running Node 18 and Yarn as input and outputs a runnable Nuxt project with linting, formatting, standardized commits, and Git hooks already wired together. The starter is published as a GitHub repository and includes a Netlify deploy status badge.

Key Features

• Nuxt 3 framework — Built on Vue 3, offering server-side rendering, static site generation, and full-stack capabilities out of the box.
• NuxtUI component library — Pre-integrated UI components for Vue that can be used immediately in pages and components.
• ESLint for JavaScript and TypeScript — yarn lint:eslint checks .ts, .js, and .vue files; yarn fix:eslint applies automatic fixes.
• Prettier formatting — yarn lint:prettier checks code style across the project, and yarn fix:prettier formats files automatically.
• Stylelint for SCSS and Vue — yarn lint:stylelint lints .scss and .vue file styles, with yarn fix:stylelint for fixing.
• Commitizen integration — yarn commit launches git-cz to create conventional commit messages; yarn commit:all stages everything first.
• Husky Git hooks — A pre-commit hook runs yarn lint:fix, and a pre-push hook (currently commented out) is ready to run yarn build.
• Yarn + NVM setup — The project uses Yarn for package management and provides an NVM configuration that selects Node 18 via nvm use.

Who is it for?

• Nuxt developers who need a ready-to-run foundation with NuxtUI and don't want to set up linting manually.
• Development teams that want consistent ESLint, Prettier, and Stylelint rules enforced on every commit and push.
• Maintainers of open source projects who benefit from Commitizen's standardized commit messages and Husky's automatic checks.
• Freelancers and agencies that build multiple Nuxt sites and need a repeatable, quality-assured starting point.

Use cases

• Frontend developers: quickly scaffold a production-ready Nuxt 3 project and start building pages with NuxtUI components.
• Code reviewers: run the single yarn lint command to check ESLint, Prettier, and Stylelint all at once before approving changes.
• Project maintainers: use yarn commit for formatted commit history and rely on the pre-commit hook to fix lint issues automatically.

How does the template work?

After installing dependencies with yarn install, run yarn dev to launch the Nuxt development server. The code quality commands are separated by tool, so you can run yarn lint:eslint, yarn lint:prettier, or yarn lint:stylelint independently. Husky runs the global yarn lint:fix on every commit, which executes all fix commands in sequence.

FAQ

What Node version does this starter require?

Node 18. The README includes an NVM configuration and instructs you to run nvm use; if you don't have Node 18 installed, you need to install it first.

What package manager should I use?

Yarn. Every command in the README is written for Yarn, including yarn dev, yarn build, and yarn commit.

What commands are available for linting and fixing?

There are three independent linters: ESLint for JS/TS/Vue, Prettier for formatting, and Stylelint for SCSS/Vue styles. yarn lint runs all checks at once, and yarn fix fixes all issues.

How does Commitizen work in this template?

The yarn commit command starts the git-cz interactive prompt to write a formatted commit message. The alternative yarn commit:all stages all modified files before starting the prompt.

Does the template have deployment configuration?

It includes a Netlify deploy status badge in the README, and the Nuxt 3 documentation referenced for deployment supports Netlify, Vercel, and other hosts. No specific deployment config is included in the repository.