Deploy a Remix site

Remix Open external link is a framework that is focused on fully utilizing the power of the web. Like Cloudflare Workers, it uses modern JavaScript APIs, and it places emphasis on web fundamentals such as meaningful HTTP status codes, caching and optimizing for both usability and performance.

In this guide, you will create a new Remix application and deploy to Cloudflare Pages.

​​ Setting up a new project

Start by installing the latest version of Remix. Create a new project directory and then intialize a Remix project by running:

$ npx create-remix@latest

After running the above command, you will be prompted to name your project in your terminal and select your deploy method. This guide uses the Cloudflare Pages deployment option.

By selecting Cloudflare Pages as your deployment option in the terminal drop-down menu, your Remix Project will generate a functions/[[path]].js file. The [[path]] filename indicates that this file will handle requests to all incoming URLs. Refer to Path segments to learn more.

After selecting your deployment option, change the directory to your project and render your project by running the following command:

# choose Cloudflare Pages
$ cd <YOUR_PROJECT>
$ npm run dev

​​ Before you continue

All of the framework guides assume you already have a fundamental understanding of Git Open external link . If you are new to Git, refer to this summarized Git handbook Open external link on how to set up Git on your local machine.

If you clone with SSH, you must generate SSH keys Open external link on each computer you use to push or pull from GitHub.

Refer to the GitHub documentation Open external link and Git documentation Open external link for more information.

​​ Create a GitHub repository

Create a new GitHub repository by visiting repo.new Open external link . After creating a new repository, prepare and push your local application to GitHub by running the following commands in your terminal:

$ git remote add origin https://github.com/<your-gh-username>/<repository-name>
$ git branch -M main
$ git push -u origin main

​​ Deploying with Cloudflare Pages

Deploy your site to Pages by logging in to the Cloudflare dashboard Open external link > Account Home > Pages and selecting Create a project. Select the new GitHub repository that you created and, in the Set up builds and deployments section, provide the following information:

After configuring your site, you can begin your first deploy. You should see Cloudflare Pages installing npm, your project dependencies, and building your site before deploying it.

After deploying your site, you will receive a unique subdomain for your project on *.pages.dev. Every time you commit new code to your Remix site, Cloudflare Pages will automatically rebuild your project and deploy it. You will also get access to preview deployments on new pull requests, so you can preview how changes look to your site before deploying them to production.

​​ Create and add a binding to your Remix application

A binding allows your application to interact with Cloudflare developer products, such as KV, Durable Object, R2, and D1 Open external link .

To add a binding to your Remix application, refer to Bindings.

​​ Use a binding in your Remix application

If you have created a KV namespace binding called PRODUCTS_KV, you can access its data in a Remix loader function Open external link .

The following code block shows an example of accessing a KV namespace in Remix.

app/routes/products/$productId.tsx
import type { LoaderArgs } from "@remix-run/cloudflare";
import { json } from "@remix-run/cloudflare";
import { useLoaderData } from "@remix-run/react";

export const loader = async ({
  context,
  params,
}: LoaderArgs) => {
  return json(
    await context.PRODUCTS_KV.get<{ name: string }>(`product-${params.productId}`, {
      type: "json",
    })
  );
};

export default function Product() {
  const product = useLoaderData<typeof loader>();

  if (!product) throw new Response(null, { status: 404 })

  return (
    <div>
      <p>Product</p>
      {product.name}
      <p>Products</p>
      {/* ... */}
    </div>
  );
}

Currently, the only way to use Durable Objects when using Cloudflare Pages is by having a separate Worker, creating a binding, and accessing it in context. For example:

export const loader = async ({ context, params }: LoaderArgs) => {
  const id = context.PRODUCTS_DO.idFromName(params.productId);
  const stub = context.PRODUCTS_DO.get(id);
  const response = await stub.fetch(request);
  const data = (await response.json()) as { name: string };
  return json(data);
};

You have to do this because there is no way to export the Durable Object class from a Pages Function.

Refer to the Durable Objects documentation to learn about deploying a Durable Object.

​​ Learn more

By completing this guide, you have successfully deployed your Remix site to Cloudflare Pages. To get started with other frameworks, refer to the list of Framework guides.