2022-09-13 12:54:31 +00:00
# Installation
2021-10-11 12:57:54 +00:00
2022-04-06 05:56:08 +00:00
Starting fresh? Getting started with Nuxt 3 is straightforward!
2021-10-11 12:57:54 +00:00
2022-08-13 07:27:04 +00:00
## Play Online
2021-10-12 18:26:16 +00:00
You can start playing with Nuxt 3 in your browser using our online sandboxes:
2021-10-29 11:26:01 +00:00
:button-link[Play on StackBlitz]{href="https://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz" blank}
2022-09-07 11:24:37 +00:00
:button-link[Play on CodeSandbox]{href="https://codesandbox.io/p/github/nuxt/starter/v3-codesandbox" blank}
2021-10-12 18:26:16 +00:00
2022-04-06 05:56:08 +00:00
## Prerequisites
Before getting started, please make sure you have installed the recommended setup.
* **Node.js**< sup > *</ sup > (latest LTS version) 👉 [[Download ](https://nodejs.org/en/download/ )]
* **Visual Studio Code** 👉 [[Download ](https://code.visualstudio.com/ )]
* **Volar Extension** 👉 [[Download ](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar )]
* Either enable [**Take Over Mode** ](https://github.com/johnsoncodehk/volar/discussions/471 ) (recommended)
* ... or add **TypeScript Vue Plugin (Volar)** 👉 [[Download ](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin )]
2022-05-20 09:07:17 +00:00
< sup > *</ sup > If you already have Node.js installed, check with `node --version` that you are using version 14.16 or above 16.11.
2022-04-06 05:56:08 +00:00
::alert{type=info}
2022-08-11 21:21:51 +00:00
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:
2022-04-06 05:56:08 +00:00
```js
export default defineNuxtConfig({
typescript: {
shim: false
}
})
```
::
2022-08-13 07:27:04 +00:00
## New Project
2021-10-11 12:57:54 +00:00
2021-10-11 16:37:38 +00:00
Open a terminal, or from [Visual Studio Code ](https://code.visualstudio.com/ ), open an [integrated terminal ](https://code.visualstudio.com/docs/editor/integrated-terminal ) and use the following command to create a new starter project:
2021-10-11 12:57:54 +00:00
2022-03-09 10:40:20 +00:00
::code-group
```bash [npx]
2022-04-20 08:52:39 +00:00
npx nuxi init nuxt-app
2021-10-11 12:57:54 +00:00
```
2022-03-09 10:40:20 +00:00
```bash [pnpm]
2022-04-20 08:52:39 +00:00
pnpm dlx nuxi init nuxt-app
2022-03-09 10:40:20 +00:00
```
::
2022-05-20 09:07:17 +00:00
Open `nuxt-app` folder in Visual Studio Code:
2021-10-11 12:57:54 +00:00
```bash
2022-04-20 08:52:39 +00:00
code nuxt-app
2021-10-11 12:57:54 +00:00
```
2021-10-11 16:37:38 +00:00
Install the dependencies:
2021-10-11 12:57:54 +00:00
2021-10-11 16:37:38 +00:00
::code-group
2021-10-29 11:26:01 +00:00
2022-03-09 10:40:20 +00:00
```bash [yarn]
2021-10-11 12:57:54 +00:00
yarn install
```
2021-10-29 11:26:01 +00:00
2022-03-09 10:40:20 +00:00
```bash [npm]
2021-10-11 16:37:38 +00:00
npm install
```
2021-10-29 11:26:01 +00:00
2022-03-09 10:40:20 +00:00
```bash [pnpm]
pnpm install --shamefully-hoist
```
2021-10-11 16:37:38 +00:00
::
2021-10-11 12:57:54 +00:00
2022-08-13 07:27:04 +00:00
## Development Server
2021-10-11 12:57:54 +00:00
2022-05-20 09:07:17 +00:00
Now you'll be able to start your Nuxt app in development mode:
2021-10-11 12:57:54 +00:00
2021-10-11 16:37:38 +00:00
::code-group
2021-10-29 11:26:01 +00:00
2022-03-09 10:40:20 +00:00
```bash [yarn]
2021-10-11 12:57:54 +00:00
yarn dev -o
```
2021-10-29 11:26:01 +00:00
2022-03-09 10:40:20 +00:00
```bash [npm]
2021-10-11 16:37:38 +00:00
npm run dev -- -o
```
2021-10-29 11:26:01 +00:00
2022-03-09 10:40:20 +00:00
```bash [pnpm]
2022-06-27 10:39:44 +00:00
pnpm run dev -o
2022-03-09 10:40:20 +00:00
```
2021-10-11 16:37:38 +00:00
::
2021-10-11 12:57:54 +00:00
2021-10-11 16:37:38 +00:00
::alert{type=success icon=✨ .font-bold}
2022-05-20 09:07:17 +00:00
Well done! A browser window should automatically open for < http: / / localhost:3000 > .
2021-10-11 16:37:38 +00:00
::
2021-10-11 12:57:54 +00:00
2022-08-13 07:27:04 +00:00
## Next Steps
2021-10-11 12:57:54 +00:00
2021-10-11 21:49:54 +00:00
Now that you've created your Nuxt 3 project, you are ready to start building your application.
2021-10-11 12:57:54 +00:00
2022-04-06 05:56:08 +00:00
* Learn about the framework [concepts ](/guide/concepts )