-
-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
23df9a5
commit f40430a
Showing
2 changed files
with
4 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1 @@ | ||
open_collective: antfu | ||
github: [antfu] | ||
github: LittleSound |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,80 +1,5 @@ | ||
<p align="center"> | ||
<img src="https://user-images.githubusercontent.com/11247099/140462375-7b7ac4db-35b7-453c-8a05-13d8d20282c4.png" width="600"/> | ||
</p> | ||
# Qrs | ||
|
||
<h2 align="center"> | ||
<a href="https://github.com/antfu/vitesse">Vitesse</a> for Nuxt 3 | ||
</h2><br> | ||
Stream data through multiple QRCodes | ||
|
||
<p align="center"> | ||
<br> | ||
<a href="https://vitesse-nuxt3.netlify.app/">π₯ Online Preview</a> | ||
<br><br> | ||
<a href="https://stackblitz.com/github/antfu/vitesse-nuxt"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt=""></a> | ||
</p> | ||
|
||
## Features | ||
|
||
- π [Nuxt 3](https://nuxt.com/) - SSR, ESR, File-based routing, components auto importing, modules, etc. | ||
|
||
- β‘οΈ Vite - Instant HMR. | ||
|
||
- π¨ [UnoCSS](https://github.com/unocss/unocss) - The instant on-demand atomic CSS engine. | ||
|
||
- π Use icons from any icon sets in Pure CSS, powered by [UnoCSS](https://github.com/unocss/unocss). | ||
|
||
- π₯ The `<script setup>` syntax. | ||
|
||
- π [State Management via Pinia](https://github.com/vuejs/pinia), see [./app/composables/user.ts](./app/composables/user.ts). | ||
|
||
- π [Layout system](./app/layouts). | ||
|
||
- π₯ APIs auto importing - for Composition API, VueUse and custom composables. | ||
|
||
- π Zero-config cloud functions and deploy. | ||
|
||
- π¦Ύ TypeScript, of course. | ||
|
||
- π² [PWA](https://github.com/vite-pwa/nuxt) with offline support and auto-update behavior. | ||
|
||
## Plugins | ||
|
||
### Nuxt Modules | ||
|
||
- [VueUse](https://github.com/vueuse/vueuse) - collection of useful composition APIs. | ||
- [ColorMode](https://github.com/nuxt-modules/color-mode) - dark and Light mode with auto detection made easy with Nuxt. | ||
- [UnoCSS](https://github.com/unocss/unocss) - the instant on-demand atomic CSS engine. | ||
- [Pinia](https://github.com/vuejs/pinia) - intuitive, type safe, light and flexible Store for Vue. | ||
- [VitePWA](https://github.com/vite-pwa/nuxt) - zero-config PWA Plugin for Nuxt 3. | ||
- [DevTools](https://github.com/nuxt/devtools) - unleash Nuxt Developer Experience. | ||
|
||
## IDE | ||
|
||
We recommend using [VS Code](https://code.visualstudio.com/) with [Volar](https://github.com/johnsoncodehk/volar) to get the best experience (You might want to disable [Vetur](https://vuejs.github.io/vetur/) if you have it). | ||
|
||
## Variations | ||
|
||
- [vitesse](https://github.com/antfu/vitesse) - Opinionated Vite Starter Template | ||
- [vitesse-lite](https://github.com/antfu/vitesse-lite) - Lightweight version of Vitesse | ||
- [vitesse-nuxt-bridge](https://github.com/antfu/vitesse-nuxt-bridge) - Vitesse for Nuxt 2 with Bridge | ||
- [vitesse-webext](https://github.com/antfu/vitesse-webext) - WebExtension Vite starter template | ||
|
||
## Try it now! | ||
|
||
### Online | ||
|
||
<a href="https://stackblitz.com/github/antfu/vitesse-nuxt"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt=""></a> | ||
|
||
### GitHub Template | ||
|
||
[Create a repo from this template on GitHub](https://github.com/antfu/vitesse-nuxt/generate). | ||
|
||
### Clone to local | ||
|
||
If you prefer to do it manually with the cleaner git history | ||
|
||
```bash | ||
npx degit antfu/vitesse-nuxt my-nuxt-app | ||
cd my-nuxt-app | ||
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm | ||
``` | ||
<video src="https://assets-storage.guii.ai/qrs-demo.mp4" width="290px" loop /> |