๐Ÿงช Qwik Labs Overview

Qwik Labs is an incubator for ideas not yet ready for production. It's a place where we can publish our "work in progress" so the community can try it out and provide feedback, without any guarantees that the feature is stable or will make it into production.

Given that these are ideas in their initial stages, chances are they will significantly change over their lifetime, so they should not be relied upon in production.

USE AT YOUR OWN RISK.

DISCLAIMER: Qwik Labs is a place to experiment, as such:

  • We make no guarantees about the stability of the API: we can break it at any point.
  • It is not ready for production: we want you to try it and give us feedback so that we can improve.
  • No guarantees that the feature will ever make it to production: it can be abandoned at any point.

Expect lots of breaking changes as the features are being developed!!!

Stages

Each Qwik Labs feature can roughly be thought of as going through these stages:

  1. proposal: An RFC proposal no code yet
  2. prototyping: An experimental stage where we explore the API, algorithm and approaches. Missing features, probably not in a usable state.
  3. implementation: We know what needs to be built and are going through the built out process.
  4. alpha: We think the project is ready to receive feedback from the community. Try it out and let us know what works and what does not.
  5. beta: We think the project is ready to graduate to the main repo and be used in production.

Installation

Qwik labs are distributed as a separate node package. Because Qwik Labs is "work in progress" the node package is not published to NPM but instead as a github URL. The package is continually updated and so it will always contains the latest build. (You may read up on installing node packages here.)

pnpm install github:QwikDev/qwik-labs-build#main

Or just add this to your package.json

{
  ...
  "dependencies": {
    ...
    "@builder.io/qwik-labs": "github:QwikDev/qwik-labs-build#main",
  }
}

Contributors

Thanks to all the contributors who have helped make this documentation better!

  • mhevery
  • Craiqser
  • mrhoodz
  • thejackshelton