Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

README.md

68 lines1.3 KB

1# TanStack Start - Cloudflare Example
2​
3A TanStack Start example demonstrating deployment to Cloudflare Workers.
4​
5- [TanStack Router Docs](https://tanstack.com/router)
6- [Cloudflare Workers Documentation](https://developers.cloudflare.com/workers/)
7​
8## Start a new project based on this example
9​
10To start a new project based on this example, run:
11​
12```sh
13npx gitpick TanStack/router/tree/main/examples/react/start-basic-cloudflare start-basic-cloudflare
14```
15​
16## Getting Started
17​
18From your terminal:
19​
20```sh
21pnpm install
22pnpm dev
23```
24​
25This starts your app in development mode, rebuilding assets on file changes.
26​
27## Build
28​
29To build the app for production:
30​
31```sh
32pnpm build
33```
34​
35## Preview
36​
37To preview the production build locally:
38​
39```sh
40pnpm preview
41```
42​
43## Deploy to Cloudflare
44​
45To deploy your app to Cloudflare Workers:
46​
47```sh
48pnpm run deploy
49```
50​
51## Accessing Cloudflare Bindings
52​
53You can access Cloudflare bindings in server functions by using importable `env`:
54​
55```ts
56import { env } from 'cloudflare:workers'
57```
58​
59See `src/routes/index.tsx` for an example.
60​
61## Cloudflare Configuration
62​
63This example includes:
64​
65- Wrangler configuration for Cloudflare Workers
66- Type generation for Cloudflare bindings
67- Server-side rendering on the edge
68- Access to Cloudflare platform features (KV, D1, R2, etc.)