Redwood

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

Init

Start by creating a new Redwood project with Alchemy:

bun

bunx alchemy create my-redwood-app --template=rwsdk
cd my-redwood-app

npm

npx alchemy create my-redwood-app --template=rwsdk
cd my-redwood-app

pnpm

pnpm dlx alchemy create my-redwood-app --template=rwsdk
cd my-redwood-app

yarn

yarn dlx alchemy create my-redwood-app --template=rwsdk
cd my-redwood-app

Login

Authenticate once with your Cloudflare account:

bun

bun alchemy login

npm

npx alchemy login

pnpm

pnpm alchemy login

yarn

yarn alchemy login

Tip

Alchemy automatically re-uses your Wrangler OAuth tokens. See the Cloudflare 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 Redwood application:

{
  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

What files are created

.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 {
  D1Database,
  DurableObjectNamespace,
  Redwood,
} from "alchemy/cloudflare";

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

const database = await D1Database("database", {
  name: "my-redwood-app-db",
  migrationsDir: "drizzle",
});

export const worker = await Redwood("website", {
  name: "my-redwood-app-website",
  bindings: {
    AUTH_SECRET_KEY: alchemy.secret(process.env.AUTH_SECRET_KEY),
    DB: database,
    SESSION_DURABLE_OBJECT: DurableObjectNamespace("session", {
      className: "SessionDurableObject",
    }),
  },
});

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

await app.finalize();

types/env.d.ts

// Auto-generated Cloudflare binding types.
// @see https://alchemy.run/concepts/bindings/#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:

{
  "compilerOptions": {
    "target": "ES2022",
    "lib": ["ES2022"],
    "module": "ES2022",
    "moduleResolution": "bundler",
    "strict": true,
    "skipLibCheck": true,
    "types": ["@cloudflare/workers-types", "./types/env.d.ts"]
  },
  "include": ["types/**/*.ts", "alchemy.run.ts", "src/**/*.ts"]
}

vite.config.mts

Use the alchemy() plugin to configure Redwood with Alchemy:

import alchemy from "alchemy/cloudflare/redwood";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [alchemy()],
});