Qwik

import { PagesBuildPreset, Render, PackageManagers } from "~/components";

Qwik is an open-source, DOM-centric, resumable web application framework designed for best possible time to interactive by focusing on resumability, server-side rendering of HTML and fine-grained lazy-loading of code.

In this guide, you will create a new Qwik application implemented via Qwik City (Qwik's meta-framework) and deploy it using Cloudflare Pages.

Creating a new project

Use the create-cloudflare CLI (C3) to create a new project. C3 will create a new project directory, initiate Qwik's official setup tool, and provide the option to deploy instantly.

To use create-cloudflare to create a new Qwik project, run the following command:

create-cloudflare will install additional dependencies, including the Wrangler CLI and any necessary adapters, and ask you setup questions.

As part of the cloudflare-pages adapter installation, a functions/[[path]].ts file will be created. The [[path]] filename indicates that this file will handle requests to all incoming URLs. Refer to Path segments to learn more.

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

npm start

Deploy with Cloudflare Pages

<Render file="deploy-via-c3" product="pages" params={{ name: "Qwik" }} />

Deploy via the Cloudflare dashboard

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.

:::note

For the complete guide to deploying your first site to Cloudflare Pages, refer to the Get started guide.

:::

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

Use bindings in your Qwik application

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

In QwikCity, add server-side code via routeLoaders and actions. Then access bindings set for your application via the platform object provided by the framework.

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

// ...

export const useGetServerTime = routeLoader$(({ platform }) => {
  // the type `KVNamespace` comes from runtime types generated by running `wrangler types`
  const { MY_KV } = (platform.env as { MY_KV: KVNamespace }));

  return {
    // ....
  }
});

<Render file="framework-guides/learn-more" product="pages" params={{ one: "Qwik" }} />