@QwikDev/astro Starter Kit
Welcome to the @QwikDev/astro starter kit! This kit enables seamless integration of Qwik components into your Astro projects, combining the efficiency of Qwik's component-based architecture with the flexibility of Astro's static site generation.
Inside of your Qwik + Astro project, you'll see the following folders and files:
/
├── public/
│ └── favicon.svg
├── src/
│ ├── assets/
│ │ ├── astro.svg
│ │ └── qwik.svg
│ ├── components/
│ │ ├── counter.module.css
│ │ └── counter.tsx
│ ├── layouts/
│ │ └── Layout.astro
│ ├── pages/
│ │ └── index.astro
│ └── styles/
│ └── globals.css
└── package.json
-
public/ : This directory contains static resources such as images, accessible from the root of your deployed site.
-
src/ : This directory is the core of your Qwik + Astro application. Here's an overview of its structure:
-
assets/ : This directory is for resources such as images, SVG files, etc.
-
components/ : Qwik components are stored here. Use this directory to organize and create reusable components for your application.
-
layouts/ : Astro layouts reside in this directory. Layout files define the overall structure of your pages.
-
pages/ : This directory contains the pages of your Astro application. Each file with the
.astro
or.md
extension is exposed as a route based on its file name. -
styles/ : Global style files for your application are stored here, such as
globals.css
.
-
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
pnpm install |
Installs dependencies |
pnpm start |
Starts local dev server at localhost:4321 |
pnpm build |
Build your production site to ./dist/ |
pnpm preview |
Preview your build locally, before deploying |
pnpm astro ... |
Run CLI commands like astro add , astro check |
pnpm astro -- --help |
Get help using the Astro CLI |
-
Astro Documentation - Explore more about Astro.
-
Qwik Documentation - Learn about Qwik and its features.
-
Astro GitHub Repository - Contribute or report issues to the Astro project.
-
Qwik GitHub Repository - Contribute or report issues to the Qwik project.
-
Qwik + Astro GitHub Repository - Explore and contribute to the @QwikDev/astro integration project.