Nuxt

This guide shows how to initialize and deploy a Nuxt 3 application to Cloudflare using Alchemy.

Init

Start by creating a new Nuxt project with Alchemy:

bun

bunx alchemy create my-nuxt-app --template=nuxt
cd my-nuxt-app

npm

npx alchemy create my-nuxt-app --template=nuxt
cd my-nuxt-app

pnpm

pnpm dlx alchemy create my-nuxt-app --template=nuxt
cd my-nuxt-app

yarn

yarn dlx alchemy create my-nuxt-app --template=nuxt
cd my-nuxt-app

Login

Authenticate once with your Cloudflare account:

bun

bun wrangler login

npm

npx wrangler login

pnpm

pnpm wrangler login

yarn

yarn wrangler login

TIP

Alchemy automatically re-uses your Wrangler OAuth tokens. See the Cloudflare Auth guide for other options.

Deploy

Run the deploy script generated by the template:

bun

bun run deploy

npm

npm run deploy

pnpm

pnpm run deploy

yarn

yarn run deploy

You'll get the live URL of your Nuxt site:

{
  url: "https://website.<your-account>.workers.dev"
}

Local Development

Work locally using the dev script:

bun

bun run dev

npm

npm run dev

pnpm

pnpm run dev

yarn

yarn run dev

Destroy

Clean up all Cloudflare resources created by this stack:

bun

bun run destroy

npm

npm run destroy

pnpm

pnpm run destroy

yarn

yarn run destroy

Explore

.env

Alchemy requires a locally set password to encrypt Secrets that are stored in state. Be sure to change this.

NOTE

See the Secret documentation to learn more.

ALCHEMY_PASSWORD=change-me

alchemy.run.ts

/// <reference types="@types/node" />

import alchemy from "alchemy";
import { Nuxt } from "alchemy/cloudflare";

const app = await alchemy("my-nuxt-app");

export const worker = await Nuxt("website", {
  command: "bun run build",
});

console.log({
  url: worker.url,
});

await app.finalize();

types/env.d.ts

// Auto-generated Cloudflare binding types.
// @see https://alchemy.run/docs/concepts/bindings.html#type-safe-bindings

import type { worker } from "../alchemy.run.ts";

export type CloudflareEnv = typeof worker.Env;

declare global {
  type Env = CloudflareEnv;
}

declare module "cloudflare:workers" {
  namespace Cloudflare {
    export interface Env extends CloudflareEnv {}
  }
}

tsconfig.json

The CLI updated the tsconfig.json to include alchemy.run.ts and register @cloudflare/workers-types + types/env.d.ts globally

TIP

The alchemy.run.ts script will be run by node but still needs to infer the Binding types which depends on @cloudflare/workers-types:

{
  "extends": "./.nuxt/tsconfig.json",
  "include": ["alchemy.run.ts", "types/**/*.ts", "server/**/*.ts"],
  "compilerOptions": {
    "types": ["@cloudflare/workers-types", "./types/env.d.ts"]
  }
}