qwik README

The project's README from github.com/QwikDev/qwik. As one markdown file: README.md.


Qwik Logo


Qwik CI



Instant-loading web apps, without effort

This is the branch for Qwik v2, currently in beta. For v1, see the `v1` branch.

Qwik offers the fastest possible page load times - regardless of the complexity of your website. Qwik is so fast because it allows fully interactive sites to load with almost no JavaScript and pick up from where the server left off.

As users interact with the site, only the necessary parts of the site load on-demand. This precision lazy-loading is what makes Qwik so quick.

Getting Started

npm create qwik@beta
# or
pnpm create qwik@beta
# or
yarn create qwik@beta
# or
bun create qwik@beta

Nightlies

We use pkg.pr.new to make packages available for each PR and for the branches. Use these URLs instead of versions to get the latest build:

Resources

Community

Development



special sponsor
Special sponsor Builder.io
sponsors
Kunaico logo
Hirez logo

qwik (QwikDev/qwik)

Searching Database…

22.1K ·GitHub
What is this?Qwik is an open-source (MIT, ~22k stars) frontend framework for building web apps that load instantly - its whole pitch is speed without manual optimization work.
Is Qwik a framework I build whole apps with, or a library I sprinkle into existing pages?It's a full framework, not a drop-in widget library: you write your entire app in Qwik. The repo also ships a CLI for scaffolding apps and a devtools browser extension for debugging.
How do I get started with it?Follow the Getting Started docs linked in the README, which also list examples and tutorials. For the freshest code, pkg.pr.new publishes a package for every PR and branch - use those URLs instead of version numbers.
What do I need installed to work on Qwik itself?To build Qwik from source you need Node.js 22.18+ and pnpm 11.22+ - the repo's engines hard-block npm and yarn in favor of pnpm. Your own Qwik app just needs a normal Node toolchain like any JS framework.
Is the current version safe to use in production?Not yet - this branch is Qwik v2, explicitly in beta, so expect instability. The README points to the v1 branch for the stable release.
Is it aimed at content sites, complex apps, or both?Both - the claim is the fastest possible page loads regardless of site complexity, so it targets everything from simple content pages to heavy interactive apps.
How does it actually get pages to load so fast?Qwik apps are resumable instead of replayable: a page starts with almost no JavaScript and picks up exactly where the server left off, then loads code on demand only for the parts the user interacts with - Qwik calls this precision lazy-loading.
What are Partytown and Mitosis, listed under Related?Sibling open-source projects: Partytown relocates resource-intensive third-party scripts off the main thread into a web worker, and Mitosis compiles components once so they run on Vue, React, Solid, Angular, Svelte and more.
What are similar projects?riot, nuxt, inferno, solid, vue, ice, hyperapp, mithril.js
Creator
QwikDev
Size
105.6 MB
Stars
22.1K
Age
5y
Commits · 90 Days