Qwik
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:
$ npm create cloudflare@latest my-qwik-app -- --framework=qwik
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
Before you continue
All of the framework guides assume you already have a fundamental understanding of Git. If you are new to Git, refer to this summarized Git handbook on how to set up Git on your local machine.
If you clone with SSH, you must generate SSH keys on each computer you use to push or pull from GitHub.
Refer to the GitHub documentation and Git documentation for more information.
Create a GitHub repository
Create a new GitHub repository by visiting repo.new. After creating a new repository, go to your newly created project directory to prepare and push your local application to GitHub by running the following commands in your terminal:
$ git init
$ git remote add origin https://github.com/<your-gh-username>/<repository-name>
$ git add .
$ git commit -m "Initial commit"
$ git branch -M main
$ git push -u origin main
Deploy with Cloudflare Pages
Deploy via the create-cloudflare CLI (C3)
If you use create-cloudflare(C3) to create your new Qwik project, C3 will install all dependencies needed for your project and prompt you to deploy your project via the CLI. If you deploy, your site will be live and you will be provided with a deployment URL.
Deploy via the Cloudflare dashboard
- Log in to the Cloudflare dashboard and select your account.
- In Account Home, select Workers & Pages > Create application > Pages > Connect to Git.
- Select the new GitHub repository that you created and, in the Set up builds and deployments section, provide the following information:
| Configuration option | Value |
|---|---|
| Production branch | main |
| Build command | npm run build |
| Build directory | dist |
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 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.
src/routes/index.tsx// ...
export const useGetServerTime = routeLoader$(({ platform }) => { // the type `KVNamespace` comes from the @cloudflare/workers-types package const { MY_KV } = (platform.env as { MY_KV: KVNamespace }));
return { // .... }
});
Learn more
By completing this guide, you have successfully deployed your Qwik site to Cloudflare Pages. To get started with other frameworks, refer to the list of Framework guides.