Quick Start

Starting fresh? Getting started with Nuxt 3 is straightforward!

Play Online

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

Play on StackBlitz Play on CodeSandbox

Prerequisites

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

* If you already have Node.js installed, check with node --version that you are using version 14.16 or 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, or from Visual Studio Code , open an integrated terminal and use the following command to create a new starter project:

npx
npx nuxi init nuxt-app
pnpm
pnpm dlx nuxi init nuxt-app

Open nuxt-app folder in Visual Studio Code:

code nuxt-app

Install the dependencies:

yarn
yarn install
npm
npm install
pnpm
pnpm install --shamefully-hoist

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.

Edit this page on GitHub Updated at Sat, Aug 13, 2022