Skip to content

README.cloudflare.md

Latest commit

 

History

History
73 lines (52 loc) · 3.75 KB

README.cloudflare.md

File metadata and controls

73 lines (52 loc) · 3.75 KB

  1. Sign up for Cloudflare (they have a free tier)

  2. Create a Pages app to host the React client. From the Compute - Workers & Pages screen, choose "Create".

  3. Select the "Pages" tab and click "Get started" in the "Use direct upload" section.

  4. Name your app and click "Create". Note: You do not need to upload any assets and click "Deploy". The Wrangler CLI and GitHub actions will take care of that later. After creating, skip step 2 and go back to the overview screen.

  5. Each time you add an app, you will see it appear in your "Workers & Pages" Overview:

  6. Add the following variables under "Variables and Secrets" so that the build command can run in the correct environment:

    Type Name Value
    Plaintext NODE_VERSION 22.9.0
    Plaintext PNPM_VERSION 9

  7. Create a Workers app to host the prod server. From the Workers & Pages Overview page, click "Create" (like step 2), and then from the "Workers" tab, click "Get started" in the section "Start with Hello World!".

  8. Name your worker and click "Deploy". Note: Ignore the worker.js code, as it will be overwritten by our app when we run our deploy script.

  9. Add a KV namespace for your prod server storage. Navigate to Storage & Databases - KV, and click "Create".

  10. Enter a name for your prod server kv namespace, and click "Create".

  11. Repeat steps 7-10 for your stage server and kv storage. Note: It might be useful to use suffix -stage in your naming.

  12. On the right hand side of the Compute - Workers & Pages Overview screen, you can find your Account ID, as well as a link to "Manage API tokens":

  13. Create an API token for "Edit Cloudflare Workers", using the provided template.

  14. Add your Cloudflare API Token and Account ID in .env. This will enable the Wrangler CLI to deploy the app locally.

  15. Add your Cloudflare API Token and Account ID to your repository secrets in GitHub. This will enable deploy from GitHub actions.

  16. Configure ENV and getServerUrl in client/src/config.ts. Note: This is just a suggestion, and you may choose another method of determining your app's runtime environment.

  17. Update server/wrangler.toml with your app names and IDs. Eg:

[env.stage]
- name = "todo-rename-stage"
+ name = "my-app-stage"
workers_dev = true
- vars = { ALLOWED_HOST = "todo:rename to stage host", ENV = "stage" }
+ vars = { ALLOWED_HOST = "my-app-stage.pages.dev", ENV = "stage" }
[[env.stage.kv_namespaces]]
binding = "DB"
- id = "e0c5eee53ed34ff69c4d8303f818adca"
+ id = "fThh47jB971c4GP452h75cP7jqE499mL"
  1. Update the deploy scripts in client/package.json to use your project name. Note: Pages allows a "Preview" branch, for all branches besides main. We use the same app name but provide --branch "stage" for our staging branch:
-    "deploy:stage": "pnpm wrangler pages deploy ./dist --project-name todo-rename --branch \"stage\"...,
+    "deploy:stage": "pnpm wrangler pages deploy ./dist --project-name my-app --branch \"stage\"...,
-    "deploy:prod": "pnpm wrangler pages deploy ./dist --project-name todo-rename",
+    "deploy:prod": "pnpm wrangler pages deploy ./dist --project-name my-app",