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

Prerequisites

Before getting started, please make sure you have installed the recommended setup.

* If you already have Node.js installed, check with node --version above 16.11.

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 file:
export default defineNuxtConfig({  typescript: {    shim: false  }})

New Project

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
pnpm install
Note: If using pnpm, make sure to have .npmrc with shamefully-hoist=true inside it before 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 run 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.