本指南将帮助你创建新的 RedwoodSDK ↗ 应用,并部署到 Cloudflare Workers。
RedwoodSDK 是在 Cloudflare 上构建服务端 Web 应用的框架。它是一个 Vite 插件,提供 SSR、React Server Components、Server Functions 和实时能力。
-
创建新项目。
运行以下命令,将
my-project-name替换为你想要的项目名称:npx create-rwsdk my-project-nameyarn dlx create-rwsdk my-project-namepnpx create-rwsdk my-project-name -
切换目录。
cd my-project-name -
安装依赖。
npm installyarn installpnpm installbun install -
在本地开发。
在项目目录中运行以下命令以启动本地开发服务器。RedwoodSDK 是 Vite 插件,因此你可以使用与其他 Vite 项目相同的开发工作流:
npm run devyarn run devpnpm run dev在浏览器中访问
http://localhost:5173,页面上应显示 "Hello, World!"。 -
添加第一个路由。
应用的入口点是
src/worker.tsx。在编辑器中打开该文件。你会看到
defineApp函数,它通过向客户端返回响应来处理请求:import { defineApp } from "rwsdk/worker"; import { route, render } from "rwsdk/router"; import { Document } from "@/app/Document"; import { Home } from "@/app/pages/Home"; export default defineApp([ render(Document, [route("/", () => new Response("Hello, World!"))]), ]);添加
/ping路由处理器:import { defineApp } from "rwsdk/worker"; import { route, render } from "rwsdk/router"; export default defineApp([ render(Document, [ route("/", () => new Response("Hello, World!")), route("/ping", function () { return <h1>Pong!</h1>; }), ]), ]);导航到
http://localhost:5173/ping查看页面上显示的 "Pong!"。路由可以直接返回 JSX。RedwoodSDK 支持 React Server Components,在服务端渲染 JSX 并将 HTML 发送给客户端。
-
部署项目。
你可以从本地机器或任何 CI/CD 系统(包括 Cloudflare Workers CI/CD)将项目部署到
*.workers.dev子域或自定义域名。使用以下命令进行构建和部署。若使用 CI,请确保相应更新 deploy command 配置。
npm run releaseyarn run releasepnpm run release首次运行该命令可能会失败并提示你创建 workers.dev 子域。前往仪表板并打开 Workers 菜单。首次打开 Workers 着陆页会自动创建 workers.dev 子域。