Nuxt.js Documentation (Official Mirror)

Play Online

If you just want to play around with Nuxt in your browser without setting up a project, you can use one of our online sandboxes:

Open on StackBlitz

i-simple-icons-stackblitz

Open on CodeSandbox

i-simple-icons-codesandbox

Or follow the steps below to set up a new Nuxt project on your computer.

New Project

Prerequisites

Node.js - 20.x or newer (but we recommend the active LTS release)
Text editor - There is no IDE requirement, but we recommend Visual Studio Code with the official Vue extension (previously known as Volar) or WebStorm, which, along with other JetBrains IDEs, offers great Nuxt support right out-of-the-box. If you use another editor, such as Neovim, you can configure Vue Language Server support by following the Vue Language Tools setup guides.
Terminal - In order to run Nuxt commands

📝 :::details Additional notes for an optimal setup: - Node.js: Make sure to use an even numbered version (20, 22, etc.) - Neovim: When configuring the Vue TypeScript plugin, make sure location points to the @vue/language-server package directory, not its binary. See the Neovim setup guide for a working configuration. - WSL: If you are using Windows and experience slow HMR, you may want to try using WSL (Windows Subsystem for Linux) which may solve some performance issues. - Windows slow DNS resolution: Instead of using localhost:3000 for local dev server on Windows, use 127.0.0.1 for much faster loading experience on browsers.

:::

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:

npm

npm create nuxt@latest <project-name>

💡 Alternatively, you can find other starters or themes by opening nuxt.new and following the instructions there.

Open your project folder in Visual Studio Code:

bash

code <project-name>

Or change directory into your new project from your terminal:

bash

cd <project-name>

Development Server

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

npm

npm run dev -- -o

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

Next Steps

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

Nuxt Concepts

New Project

Prerequisites

Node.js - 20.x or newer (but we recommend the active LTS release)

Text editor - There is no IDE requirement, but we recommend Visual Studio Code with the official Vue extension (previously known as Volar) or WebStorm, which, along with other JetBrains IDEs, offers great Nuxt support right out-of-the-box. If you use another editor, such as Neovim, you can configure Vue Language Server support by following the Vue Language Tools setup guides.

Terminal - In order to run Nuxt commands

:::

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:

npm

npm create nuxt@latest <project-name>

💡 Alternatively, you can find other starters or themes by opening nuxt.new and following the instructions there.

Open your project folder in Visual Studio Code:

bash

code <project-name>

Or change directory into your new project from your terminal:

bash

cd <project-name>