Nuxt/docs/1.getting-started/2.installation.md

navigation.icon
uil:play-circle

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:

:button-link[Play on StackBlitz]{href="https://nuxt.new/s/v3" blank .mr-2} :button-link[Play on CodeSandbox]{href="https://nuxt.new/c/v3" blank}

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

:button-link[Discover nuxt.new]{href="https://nuxt.new" blank}

New Project

Prerequisites

• Node.js - v16.10.0 or newer
• Text editor - We recommend Visual Studio Code with the Volar Extension
• Terminal - In order to run Nuxt commands

::alert ::details :summary[Additional notes for an optimal setup:]

• Node.js: Make sure to use an even numbered version (18, 20, etc)
• Nuxtr: Install the community-developed Nuxtr extension
• Volar: Either enable Take Over Mode (recommended) or add the TypeScript Vue Plugin

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:

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:

::code-group

npx nuxi@latest init <project-name>

pnpm dlx nuxi@latest init <project-name>

bunx nuxi@latest init <project-name>

::

Open your project folder in Visual Studio Code:

code <project-name>

Install the dependencies:

::code-group

yarn install

npm install

# 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:

::code-group

yarn dev -o

npm run dev -- -o

pnpm dev -o

::

::alert{type=success icon=✨ .font-bold} 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.

• Learn about the framework concepts