Skip to content

docs: Update Cloudflare hosting guide #5357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 3, 2025
+12 −22
Merged

docs: Update Cloudflare hosting guide #5357

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 12 additions & 22 deletions docs/start/framework/react/hosting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,15 @@ Once you've chosen a deployment target, you can follow the deployment guidelines
</picture>
</a>

### Cloudflare Workers

When deploying to Cloudflare Workers, you'll need to complete a few extra steps before your users can start using your app.

1. Install `@cloudflare/vite-plugin`
1. Install `@cloudflare/vite-plugin` and `wrangler`

```bash
pnpm install @cloudflare/vite-plugin -D
pnpm add -D @cloudflare/vite-plugin wrangler
```

2. Update `vite.config.ts`

Add the cloudflare plugin to your `vite.config.ts` file.
2. Add the Cloudflare plugin to your `vite.config.ts` file

```ts
// vite.config.ts
Expand All @@ -67,42 +63,36 @@ export default defineConfig({
})
```

3. Install `wrangler`

```bash
pnpm add wrangler -D
```

4. Add a `wrangler.json` config file
3. Add a `wrangler.jsonc` config file

```json
{
"$schema": "node_modules/wrangler/config-schema.json",
"name": "tanstack-start-app",
"compatibility_date": "2025-09-02",
"compatibility_flags": ["nodejs_compat"],
"main": "@tanstack/react-start/server-entry",
"vars": {
"MY_VAR": "Hello from Cloudflare"
}
"main": "@tanstack/react-start/server-entry"
}
```

5. Modify package.json script
4. Modify the scripts in your `package.json` file

```json
{
"scripts": {
"dev": "vite dev",
"build": "vite build && tsc --noEmit",
// ============ 👇 remove this line ============
"start": "node .output/server/index.mjs",
// ============ 👇 add this line ============
"deploy": "wrangler deploy"
// ============ 👇 add these lines ============
"preview": "vite preview",
"deploy": "wrangler deploy",
"cf-typegen": "wrangler types"
}
}
```

6. Build and deploy
5. Build and deploy

```bash
pnpm run build && pnpm run deploy
Expand Down
Loading