Skip to content
Cloudflare Docs

Next.js

Start from CLI - scaffold a Next.js project on Workers.

Terminal window
npm create cloudflare@latest my-next-app -- --framework=next --platform=workers

This is a simple getting started guide. For detailed documentation on how the to use the Cloudflare OpenNext adapter, visit the OpenNext website ↗.

What is Next.js?

Next.js ↗ is a React ↗ framework for building full stack applications.

Next.js supports Server-side and Client-side rendering, as well as Partial Prerendering which lets you combine static and dynamic components in the same route.

You can deploy your Next.js app to Cloudflare Workers using the OpenNext adaptor.

Deploy a new Next.js project on Workers

  1. Create a new project with the create-cloudflare CLI (C3).

    Terminal window
    npm create cloudflare@latest my-next-app -- --framework=next --platform=workers

    What's happening behind the scenes?

    When you run this command, C3 creates a new project directory, initiates Next.js's official setup tool ↗, and configures the project for Cloudflare. It then offers the option to instantly deploy your application to Cloudflare.

  2. Develop locally.

    After creating your project, run the following command in your project directory to start a local development server. The command uses the Next.js development server. It offers the best developer experience by quickly reloading your app every time the source code is updated.

    Terminal window
    npm run dev

  3. Test and preview your site with the Cloudflare adapter.

    Terminal window
    npm run preview

    What's the difference between dev and preview?

    The command used in the previous step uses the Next.js development server, which runs in Node.js. However, your deployed application will run on Cloudflare Workers, which uses the workerd runtime. Therefore when running integration tests and previewing your application, you should use the preview command, which is more accurate to production, as it executes your application in the workerd runtime using wrangler dev.

  4. Deploy your project.

    You can deploy your project to a *.workers.dev subdomain or a custom domain from your local machine or any CI/CD system (including Workers Builds). Use the following command to build and deploy. If you're using a CI service, be sure to update your "deploy command" accordingly.

    Terminal window
    npm run deploy

Deploy an existing Next.js project on Workers

You can convert an existing Next.js application to run on Cloudflare

  1. Install @opennextjs/cloudflare ↗

    Terminal window
    npm install @opennextjs/cloudflare@latest

  2. Add a Wrangler configuration file

    In your project root, create a Wrangler configuration file with the following content:

    {
      "main": ".open-next/worker.js",
      "name": "my-app",
      "compatibility_date": "2025-03-25",
      "compatibility_flags": [
        "nodejs_compat"
      ],
      "assets": {
        "directory": ".open-next/assets",
        "binding": "ASSETS"
      }
    }

  3. Add a configuration file for OpenNext

    In your project root, create an OpenNext configuration file named open-next.config.ts with the following content:

    import { defineCloudflareConfig } from "@opennextjs/cloudflare";
    

    export default defineCloudflareConfig();

  4. Update package.json

    You can add the following scripts to your package.json:

    "preview": "opennextjs-cloudflare build && opennextjs-cloudflare preview",
    "deploy": "opennextjs-cloudflare build && opennextjs-cloudflare deploy",
    "cf-typegen": "wrangler types --env-interface CloudflareEnv cloudflare-env.d.ts"

    Usage
    • preview: Builds your app and serves it locally, allowing you to quickly preview your app running locally in the Workers runtime, via a single command. - deploy: Builds your app, and then deploys it to Cloudflare - cf-typegen: Generates a cloudflare-env.d.ts file at the root of your project containing the types for the env.

  5. Develop locally.

    After creating your project, run the following command in your project directory to start a local development server. The command uses the Next.js development server. It offers the best developer experience by quickly reloading your app after your source code is updated.

    Terminal window
    npm run dev

  6. Test your site with the Cloudflare adapter.

    The command used in the previous step uses the Next.js development server to offer a great developer experience. However your application will run on Cloudflare Workers so you want to run your integration tests and verify that your application workers correctly in this environment.

    Terminal window
    npm run preview

  7. Deploy your project.

    You can deploy your project to a *.workers.dev subdomain or a custom domain from your local machine or any CI/CD system (including Workers Builds). Use the following command to build and deploy. If you're using a CI service, be sure to update your "deploy command" accordingly.

    Terminal window
    npm run deploy