2022-10-06 09:15:30 +00:00
---
navigation.icon: uil:play-circle
---
2022-09-13 12:54:31 +00:00
# Installation
2021-10-11 12:57:54 +00:00
2022-10-06 09:15:30 +00:00
Get started with Nuxt quickly with our online starters or start locally with your terminal.
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:
2023-03-21 17:13:58 +00:00
: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}
2021-10-12 18:26:16 +00:00
2022-11-28 13:07:24 +00:00
Start with one of our starters and themes directly by opening [nuxt.new ](https://nuxt.new ).
2022-11-28 13:03:11 +00:00
:button-link[Discover nuxt.new]{href="https://nuxt.new" blank}
2023-03-09 13:34:18 +00:00
## New Project
2022-04-06 05:56:08 +00:00
2023-04-04 13:23:13 +00:00
<!-- TODO: need to fix upstream in nuxt/nuxt.com -->
<!-- markdownlint - disable - next - line MD001 -->
2023-03-15 14:28:56 +00:00
#### Prerequisites
2023-04-04 13:23:13 +00:00
2023-03-15 14:28:56 +00:00
- **Node.js** - [`v16.10.0` ](https://nodejs.org/en/ ) or newer
2023-04-04 13:23:13 +00:00
- **Text editor** - We recommend [Visual Studio Code ](https://code.visualstudio.com/ ) with the [Volar Extension ](https://marketplace.visualstudio.com/items?itemName=Vue.volar )
2023-03-15 14:28:56 +00:00
- **Terminal** - In order to run Nuxt commands
2023-03-09 13:34:18 +00:00
::alert
2023-04-04 13:23:13 +00:00
::details
:summary[Additional notes for an optimal setup:]
2023-04-24 21:24:38 +00:00
- **Node.js**: Make sure to use an even numbered version (18, 20, etc)
2023-04-04 13:23:13 +00:00
- **Volar**: Either enable [**Take Over Mode** ](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode ) (recommended) or add the [TypeScript Vue Plugin ](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-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:
```ts [nuxt.config.ts]
export default defineNuxtConfig({
typescript: {
shim: false
}
})
```
::
2022-04-06 05:56:08 +00:00
::
2022-10-12 09:42:07 +00:00
Open a terminal (if you're using [Visual Studio Code ](https://code.visualstudio.com/ ), you can 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-11-30 17:11:17 +00:00
npx nuxi init < project-name >
2021-10-11 12:57:54 +00:00
```
2022-03-09 10:40:20 +00:00
```bash [pnpm]
2022-11-30 17:11:17 +00:00
pnpm dlx nuxi init < project-name >
2022-03-09 10:40:20 +00:00
```
::
2022-11-30 17:11:17 +00:00
Open your project folder in Visual Studio Code:
2021-10-11 12:57:54 +00:00
```bash
2022-11-30 17:11:17 +00:00
code < project-name >
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]
2022-12-20 15:48:10 +00:00
# Make sure you have `shamefully-hoist=true` in `.npmrc` before running pnpm install
2022-11-11 10:13:52 +00:00
pnpm install
2022-03-09 10:40:20 +00:00
```
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-12-20 15:48:10 +00:00
pnpm 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
2023-04-04 13:23:13 +00:00
- Learn about the framework [concepts ](/docs/guide/concepts/auto-imports )