aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Sanyam Kamat <1625114+sanyamkamat@users.noreply.github.com> 2023-09-20 10:24:45 +0530
committerGravatar GitHub <noreply@github.com> 2023-09-19 21:54:45 -0700
commitee33d5ced49ceaa70a2e73da59351818a0b9fab3 (patch)
tree6a3eb0078a0a29dc7131a0a28912bfdf788befb1
parent53fd9ff4bf08aa3132b28c1f8b2cc2ee3fc396a2 (diff)
downloadbun-ee33d5ced49ceaa70a2e73da59351818a0b9fab3.tar.gz
bun-ee33d5ced49ceaa70a2e73da59351818a0b9fab3.tar.zst
bun-ee33d5ced49ceaa70a2e73da59351818a0b9fab3.zip
docs: add Qwik guide (#4810)
-rw-r--r--docs/guides/ecosystem/qwik.md107
1 files changed, 107 insertions, 0 deletions
diff --git a/docs/guides/ecosystem/qwik.md b/docs/guides/ecosystem/qwik.md
new file mode 100644
index 000000000..45d3f9c1a
--- /dev/null
+++ b/docs/guides/ecosystem/qwik.md
@@ -0,0 +1,107 @@
+---
+name: Build an app with Qwik and Bun
+---
+
+Initialize a new Qwik app with `bunx create-qwik`.
+
+The `create-qwik` package detects when you are using `bunx` and will automatically install dependencies using `bun`.
+
+```sh
+$ bun create qwik
+
+ ............
+ .::: :--------:.
+ .:::: .:-------:.
+ .:::::. .:-------.
+ ::::::. .:------.
+ ::::::. :-----:
+ ::::::. .:-----.
+ :::::::. .-----.
+ ::::::::.. ---:.
+ .:::::::::. :-:.
+ ..::::::::::::
+ ...::::
+
+
+┌ Let's create a Qwik App ✨ (v1.2.10)
+│
+◇ Where would you like to create your new project? (Use '.' or './' for current directory)
+│ ./my-app
+│
+● Creating new project in /path/to/my-app ... 🐇
+│
+◇ Select a starter
+│ Basic App
+│
+◇ Would you like to install bun dependencies?
+│ Yes
+│
+◇ Initialize a new git repository?
+│ No
+│
+◇ Finishing the install. Wanna hear a joke?
+│ Yes
+│
+○ ────────────────────────────────────────────────────────╮
+│ │
+│ How do you know if there’s an elephant under your bed? │
+│ Your head hits the ceiling! │
+│ │
+├──────────────────────────────────────────────────────────╯
+│
+◇ App Created 🐰
+│
+◇ Installed bun dependencies 📋
+│
+○ Result ─────────────────────────────────────────────╮
+│ │
+│ Success! Project created in my-app directory │
+│ │
+│ Integrations? Add Netlify, Cloudflare, Tailwind... │
+│ bun qwik add │
+│ │
+│ Relevant docs: │
+│ https://qwik.builder.io/docs/getting-started/ │
+│ │
+│ Questions? Start the conversation at: │
+│ https://qwik.builder.io/chat │
+│ https://twitter.com/QwikDev │
+│ │
+│ Presentations, Podcasts and Videos: │
+│ https://qwik.builder.io/media/ │
+│ │
+│ Next steps: │
+│ cd my-app │
+│ bun start │
+│ │
+│ │
+├──────────────────────────────────────────────────────╯
+│
+└ Happy coding! 🎉
+
+```
+
+---
+
+Run `bun run dev` to start the development server.
+
+```sh
+$ bun run dev
+ $ vite--mode ssr
+
+ VITE v4.4.7 ready in 1190 ms
+
+ ➜ Local: http://localhost:5173/
+ ➜ Network: use --host to expose
+ ➜ press h to show help
+```
+
+---
+
+Open [http://localhost:5173](http://localhost:5173) with your browser to see the result. Qwik will hot-reload your app as you edit your source files.
+
+{% image src="https://github.com/oven-sh/bun/assets/3084745/ec35f2f7-03dd-4c90-851e-fb4ad150bb28" alt="Qwik screenshot" /%}
+
+---
+
+Refer to the [Qwik docs](https://qwik.builder.io/docs/getting-started/) for complete documentation.