Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siguici/qwik-astro-biome
A template to get started with @QwikDev/astro, @nodejs and @biomejs.
https://github.com/siguici/qwik-astro-biome
astro biomejs nodejs qwik repository-template starter-kit
Last synced: about 1 month ago
JSON representation
A template to get started with @QwikDev/astro, @nodejs and @biomejs.
- Host: GitHub
- URL: https://github.com/siguici/qwik-astro-biome
- Owner: siguici
- Created: 2024-04-18T22:38:35.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-19T13:00:07.000Z (10 months ago)
- Last Synced: 2024-11-12T14:30:31.686Z (3 months ago)
- Topics: astro, biomejs, nodejs, qwik, repository-template, starter-kit
- Language: Astro
- Homepage:
- Size: 66.4 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [@QwikDev/astro](https://github.com/QwikDev/astro) Starter Kit
## Overview
Welcome to the [@QwikDev/astro](https://github.com/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.
## 🚀 Project Structure
Inside of your [Qwik](https://qwik.dev/) + [Astro](https://astro.build/) project, you'll see the following folders and files:
```text
/
├── 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`.
## 🧞 Commands
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 |
## 📚 References
- [Astro Documentation](https://astro.build/) - Explore more about Astro.
- [Qwik Documentation](https://qwik.dev/) - Learn about Qwik and its features.
- [Astro GitHub Repository](https://github.com/withastro/astro) - Contribute or report issues to the Astro project.
- [Qwik GitHub Repository](https://github.com/BuilderIO/qwik) - Contribute or report issues to the Qwik project.
- [Qwik + Astro GitHub Repository](https://github.com/QwikDev/astro) - Explore and contribute to the @QwikDev/astro integration project.