Nuxt/docs/6.bridge/8.nitro.md
Sébastien Chopin f26a801775
docs: update to new website (#23743)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Daniel Roe <daniel@roe.dev>
2023-10-18 12:59:43 +02:00

1.7 KiB

title description
Nitro Activate Nitro to your Nuxt 2 application with Nuxt Bridge.

Remove Modules

  • Remove @nuxt/nitro: Bridge injects same functionality

Update Config

import { defineNuxtConfig } from '@nuxt/bridge'

export default defineNuxtConfig({
  bridge: {
    nitro: true
  }
})

Update Your Scripts

You will also need to update your scripts within your package.json to reflect the fact that Nuxt will now produce a Nitro server as build output.

Install Nuxi

Install nuxi as a development dependency:

::code-group

yarn add --dev nuxi
npm install -D nuxi

::

Nuxi

Nuxt 3 introduced the new Nuxt CLI command nuxi. Update your scripts as follows to leverage the better support from Nuxt Bridge:

{
  "scripts": {
-   "dev": "nuxt",
+   "dev": "nuxi dev",
-   "build": "nuxt build",
+   "build": "nuxi build",
-   "start": "nuxt start",
+   "start": "nuxi preview"
  }
}

::callout If nitro: false, use the nuxt2 command. ::

Static Target

If you have set target: 'static' in your nuxt.config then you need to ensure that you update your build script to be nuxi generate.

{
  "scripts": {
    "build": "nuxi generate"
  }
}

Server Target

For all other situations, you can use the nuxi build command.

{
  "scripts": {
    "build": "nuxi build",
    "start": "nuxi preview"
  }
}

Exclude Built Nitro Folder From Git

Add the folder .output to the .gitignore file.

Ensure Everything Goes Well

✔️ Try with nuxi dev and nuxi build (or nuxi generate) to see if everything goes well.