Astro

Astro is a flexible meta-framework that accommodates a wide range of tools and integrations, enabling you to leverage numerous ecosystems.

It also allows you to write components using your favorite UI framework (or no framework at all) and renders your pages to static HTML at build time, or dynamically on the server using Server-Side Rendering (SSR).

This results in a fast, SEO-friendly output that can be deployed to any static hosting environment or server.

For more details on the integration and to view the source code, check out the QwikDev Astro Integration on GitHub.

Astro instead of Qwik City

When integrating Astro with Qwik, it's important to note that Qwik City APIs are not compatible with Astro.

Astro is a meta-framework that provides its own set of APIs and features for handling these concerns. These include but are not limited to:

• routing
• pages
• layouts
• data fetching

When using Qwik with Astro, use Astro's APIs instead of Qwik City's. This ensures your Qwik components work correctly in Astro. See the Astro documentation for more details.

@qwik.dev/astro 💜

This integration leverages the power of JavaScript Streaming inside of Astro, using Qwik components.

Installation

The @qwik.dev/astro CLI 🦾

To start a new Qwik Astro project, you can run the following command:

pnpm create @qwik.dev/astro

npm create @qwik.dev/astro

yarn create @qwik.dev/astro

bun create @qwik.dev/astro

For more advanced CLI configuration options, see the @qwik.dev/astro CLI documentation.

Existing projects

Astro comes with a command-line tool for incorporating built-in integrations: astro add. This command will:

1. Optionally install all required dependencies and peer dependencies
2. Optionally modify your astro.config.* file to apply the integration

To install @qwik.dev/astro, run the following from your project directory and follow the prompts:

pnpm dlx astro add @qwik.dev/astro

npx astro add @qwik.dev/astro

yarn dlx astro add @qwik.dev/astro

bunx astro add @qwik.dev/astro

Setting up the TypeScript Config

When using Astro's integration CLI or manually adding the integration, Qwik needs the following in tsconfig.json for typescript to recognize Qwik's JSX types.

"compilerOptions": {
  "jsx": "react-jsx",
  "jsxImportSource": "@qwik.dev/core"
}

If you face any issues, please post them on Github and attempt the manual installation below.

Manual Installation

First, install the @qwik.dev/astro integration like so:

pnpm install @qwik.dev/astro

npm install @qwik.dev/astro

yarn add @qwik.dev/astro

bun install @qwik.dev/astro

Typically, package managers install peer dependencies. However, if you get a Cannot find package '@qwik.dev/core' warning when starting Astro, install Qwik.

pnpm install @qwik.dev/core

npm install @qwik.dev/core

yarn add @qwik.dev/core

bun install @qwik.dev/core

Now, add the integration to your astro.config.* file using the integrations property:

  // astro.config.mjs
  import { defineConfig } from 'astro/config';
+ import qwikdev from '@qwik.dev/astro';
 
  export default defineConfig({
    // ...
    integrations: [qwikdev()],
    //             ^^^^^
  });

Learn More

For more documentation on using Qwik and Astro, the integration README is a great place to start.