SvelteKit

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

Init

Start by creating a new SvelteKit project with Alchemy:

bun

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

npm

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

pnpm

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

yarn

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

Log in to Cloudflare

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 SvelteKit 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

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 { SvelteKit } from "alchemy/cloudflare";

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

export const worker = await SvelteKit("website");

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:

{
  "extends": "./.svelte-kit/tsconfig.json",
  "include": ["alchemy.run.ts", "types/**/*.ts"],
  "compilerOptions": {
    // (omitted for brevity ..)
    "types": ["@cloudflare/workers-types", "./types/env.d.ts"]
  }
}

svelte.config.js

Use the alchemy() adapter to configure SvelteKit for local development and deployment to Cloudflare Workers:

import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
import alchemy from 'alchemy/cloudflare/sveltekit';

/** @type {import('@sveltejs/kit').Config} */
const config = {
  // Consult https://svelte.dev/docs/kit/integrations
  // for more information about preprocessors
  preprocess: vitePreprocess(),

  kit: {
    // Using Cloudflare adapter for deployment to Cloudflare Workers
    // See https://svelte.dev/docs/kit/adapters for more information about adapters.
    adapter: alchemy()
  }
};

export default config;