Skip to content
Get packs

Guide · Open source

How to use Qwik: install, start a project and know what to expect

Updated · written with AI from the project's own documentation and checked against our catalogue data

Qwik is an open-source, MIT-licensed web framework written in TypeScript for building websites and web apps. According to its README, it is designed to load pages quickly by sending almost no JavaScript up front and picking up where the server left off. This guide shows how to create a Qwik project, what the framework is built around, and whether it suits your project before you commit to it.

QwikQwikDev/qwik · ★ 22.1k · MIT

Quick start

  1. 1Check prerequisites. Confirm Node.js is installed or that you have a compatible package manager such as npm, pnpm, yarn or bun.
  2. 2Create the project. Run the create command for your package manager, such as npm create qwik@beta.
  3. 3Read the core concepts. Work through the resumable versus replayable page and the mental model page on the official docs site.
  4. 4Follow a tutorial. Open the official tutorials at next.qwik.dev to build something end to end.
  5. 5Try an example. Browse the examples section to see small working projects and copy patterns that fit your use case.
  6. 6Ask for help if stuck. Join the Discord community linked in the README to ask questions.

What is Qwik and what problem does it target?

Qwik is a web framework for building websites and web apps. Its README describes the goal as fast page loads regardless of how complex the site is. It does this by letting a fully interactive page load with almost no JavaScript, then resuming the page where the server left off.

As users interact with the site, only the parts they need are loaded on demand. The project calls this precision lazy-loading.

  • Resumable: the page continues from server state instead of re-running everything on the client
  • Lazy-loading: additional code loads only as users interact with the relevant parts of the site

Install Qwik and create a new project

The README lists Node.js or a compatible package manager as the prerequisite. Qwik's README gives create commands for npm, pnpm, yarn and bun. Run the one that matches your package manager to scaffold a new project.

The README's Getting Started section uses the beta create command, because the v2 branch is the one currently documented there.

  • npm: npm create qwik@beta
  • pnpm: pnpm create qwik@beta
  • yarn: yarn create qwik@beta
  • bun: bun create qwik@beta
npm create qwik@beta

Understand resumable rendering before you build

Qwik's core idea is resumability, which the README contrasts with replayable applications. Before writing components, the README recommends reading the docs on resumable versus replayable apps and on Qwik's high-level mental model.

This concept is new for many developers. The README itself notes that it introduces its own concepts, so plan time to learn them.

  • Read the resumable and replayable concepts page at next.qwik.dev
  • Read the mental model page at next.qwik.dev

Choose the right version: v2 beta or v1

The repository's main branch is for Qwik v2, which the README says is currently in beta. The v1 code lives on a separate v1 branch.

If you need a stable release today, the README's guidance points you to v1 rather than the beta. Check the branch and docs you are following so the commands and APIs match.

  • v2: the branch the Getting Started commands target, currently beta
  • v1: available on the v1 branch of the repository

Explore the docs, examples and tutorials

The README links to official resources. Start with the tutorials for a guided path, then use the examples to see small working projects.

Videos, podcasts, presentations and blogs are also linked, and the Discord community is listed for questions.

  • Docs: next.qwik.dev
  • Examples: next.qwik.dev/examples/introduction/hello-world/
  • Tutorials: next.qwik.dev/tutorial/welcome/overview/
  • Community chat: Discord via qwik.dev/chat

What people use it for

  • Content-heavy sites where page load speed matters
  • Interactive pages that should not ship large amounts of JavaScript up front
  • Experimenting with resumable rendering as an alternative to hydration-based frameworks

Frequently asked questions

Is Qwik free to use?

Yes. The repository is licensed under MIT, which is a permissive open-source licence. Check the LICENSE file in the repository for the full terms.

How do I install Qwik?

Run npm create qwik@beta with npm, or pnpm create qwik@beta with pnpm. The README also lists yarn and bun equivalents. You need Node.js or a compatible package manager.

Is Qwik stable enough for production?

The README says the v2 branch is currently in beta. If you need a stable release today, the README points to the v1 branch instead. Weigh that before choosing it for a production project.

What do I need to know before using Qwik?

The README says Qwik introduces its own concepts, such as resumability. It is best suited to developers with web development experience who want to learn these ideas.

How does Qwik compare to Next.js, Astro, SvelteKit or Remix?

Those are comparable frameworks. This guide does not benchmark them, and the README does not make comparative claims. Build a small prototype in each if performance and developer experience matter for your choice.

Where can I get help if something breaks?

Use the official docs at next.qwik.dev, the examples and tutorials, or join the Discord community linked from the README and the GitHub repository issues.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Qwik suits developers building content-heavy or interactive sites who want fast loads and are curious about resumable rendering. It is a weaker fit for beginners, for teams that need a stable release today given the v2 beta status, or for projects that depend on an ecosystem the README does not mention.

Install options & downloads