Installation

Get started with Nuxt quickly with our online starters or start locally with your terminal.

Play Online

You can start playing with Nuxt 3 in your browser using our online sandboxes:

Play on StackBlitzPlay on CodeSandbox

Start with one of our starters and themes directly by opening nuxt.new.

Discover nuxt.new

New Project

Prerequisites

Additional notes for an optimal setup:

If you have enabled Take Over Mode or installed the TypeScript Vue Plugin (Volar), you can disable generating the shim for *.vue files in your nuxt.config.ts file:

nuxt.config.ts
export default defineNuxtConfig({
  typescript: {
    shim: false
  }
})

Open a terminal (if you're using Visual Studio Code, you can open an integrated terminal) and use the following command to create a new starter project:

npx
npx nuxi init <project-name>
pnpm
pnpm dlx nuxi init <project-name>

Open your project folder in Visual Studio Code:

code <project-name>

Install the dependencies:

yarn
yarn install
npm
npm install
pnpm
# Make sure you have `shamefully-hoist=true` in `.npmrc` before running pnpm install
pnpm install

Development Server

Now you'll be able to start your Nuxt app in development mode:

yarn
yarn dev -o
npm
npm run dev -- -o
pnpm
pnpm dev -o

Well done! A browser window should automatically open for http://localhost:3000.

Next Steps

Now that you've created your Nuxt 3 project, you are ready to start building your application.