-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Workers react framework guide #20214
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.
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
petebacondarwin
merged 7 commits into
production
from
tori/19653-reactjs-framework-guide-for-workers
Mar 6, 2025
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
412a05b
Workers react framework guide
ToriLindsay 1c9128c
Update src/content/docs/workers/frameworks/framework-guides/react.mdx
ToriLindsay 01d136d
Update src/content/docs/workers/frameworks/framework-guides/react.mdx
ToriLindsay 406cae8
Update src/content/docs/workers/frameworks/framework-guides/react.mdx
ToriLindsay 4a03ee2
Apply suggestions from code review
ToriLindsay 6f4b7ca
Apply suggestions from code review
ToriLindsay 03998e9
Update src/content/docs/workers/frameworks/framework-guides/react.mdx
petebacondarwin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
69 changes: 69 additions & 0 deletions
69
src/content/docs/workers/frameworks/framework-guides/react.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| pcx_content_type: how-to | ||
| title: React | ||
| head: [] | ||
| description: Create a React application and deploy it to Cloudflare Workers with Workers Assets. | ||
| --- | ||
|
|
||
| import { | ||
| Badge, | ||
| Description, | ||
| InlineBadge, | ||
| Render, | ||
| PackageManagers, | ||
| } from "~/components"; | ||
|
|
||
| In this guide, you will create a new [React](https://react.dev/) application and deploy to Cloudflare Workers (with the new [<InlineBadge preset="beta" /> Workers Assets](/workers/static-assets/)). | ||
|
|
||
| ## 1. Set up a new project | ||
|
|
||
| Use the [`create-cloudflare`](https://www.npmjs.com/package/create-cloudflare) CLI (C3) to set up a new project. C3 will create a new project directory, use code from the official React template, and provide the option to deploy instantly. | ||
|
|
||
| To use `create-cloudflare` to create a new React project with <InlineBadge preset="beta" /> Workers Assets, run the following command: | ||
|
|
||
| <PackageManagers | ||
| type="create" | ||
| pkg="cloudflare@latest my-react-app" | ||
| args={"--framework=react --experimental"} | ||
petebacondarwin marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| /> | ||
|
|
||
| <Render | ||
| file="c3-post-run-steps" | ||
| product="workers" | ||
| params={{ | ||
| category: "web-framework", | ||
| framework: "React", | ||
| }} | ||
| /> | ||
|
|
||
| After setting up your project, change your directory by running the following command: | ||
|
|
||
| ```sh | ||
| cd my-react-app | ||
| ``` | ||
|
|
||
| ## 2. Develop locally | ||
|
|
||
| After you have created your project, run the following command in the project directory to start a local server. This will allow you to preview your project locally during development. | ||
|
|
||
| <PackageManagers type="run" args={"dev"} /> | ||
|
|
||
| ## 3. Deploy your Project | ||
ToriLindsay marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including [Cloudflare's own](/workers/ci-cd/builds/). | ||
|
|
||
| The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/configuration/#build-settings) configuration appropriately. | ||
ToriLindsay marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <PackageManagers type="run" args={"deploy"} /> | ||
|
|
||
| --- | ||
|
|
||
ToriLindsay marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Bindings | ||
ToriLindsay marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
ToriLindsay marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Your React application can be fully integrated with the Cloudflare Developer Platform, in both local development and in production, by using product bindings. The [React documentation](UPDATE) provides information about configuring bindings. | ||
petebacondarwin marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
ToriLindsay marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Static assets | ||
|
|
||
| You can serve static assets in your React application by placing them in [the `./public/` directory](UPDATE). This can be useful for resource files such as images, stylesheets, fonts, and manifests. | ||
ToriLindsay marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <Render file="workers-assets-routing-summary" /> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.