Nuxt/docs/content/1.docs/1.getting-started/2.installation.md
Sébastien Chopin 90784f79d7
docs: new website design (#9007)
* docs: implement new website theme

* chore: rename dirs

* chore: update build

* lint fix

* chore: update deps

* fix: include node_modules in esbuild step

* chore: update deps

* Update .gitignore

* chore: update theme version

* up

* up

* fix: use svg for illustration

* chore: update to 0.0.12

* chore: force parse5 resolution

* stay with build

* feat: always display first home section

* Update yarn.lock

* chore: update theme

* fix lint

* docs: update home title

* chore: update website theme version

* Update docs/content/0.index.md

Co-authored-by: pooya parsa <pyapar@gmail.com>

* Update docs/content/0.index.md

Co-authored-by: pooya parsa <pyapar@gmail.com>

* up

* chore: bump theme version

* up

* chore: up

* up up and up

* chore: generate

* fix: boolean value

* feat: new images

* update again

* chore: up

* ouep

* chore: up

Co-authored-by: Daniel Roe <daniel@roe.dev>
Co-authored-by: Clément Ollivier <clement.o2p@gmail.com>
Co-authored-by: pooya parsa <pyapar@gmail.com>
2022-11-16 11:04:28 +01:00

2.7 KiB

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://stackblitz.com/github/nuxt/starter/tree/v3-stackblitz" blank .mr-2} :button-link[Play on CodeSandbox]{href="https://codesandbox.io/s/github/nuxt/starter/tree/v3-codesandbox" blank}

Prerequisites

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

* If you already have Node.js installed, check with node --version above 16.11.

::alert{type=info}

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 (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 init nuxt-app
pnpm dlx nuxi init nuxt-app

::

Open nuxt-app folder in Visual Studio Code:

code nuxt-app

Install the dependencies:

::code-group

yarn install
npm install
pnpm install

::

::alert Note: If using pnpm, make sure to have .npmrc with shamefully-hoist=true inside it before 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 run 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.