update: readme
This commit is contained in:
parent
2a8e96cf78
commit
dc6f18697c
72
README.md
72
README.md
|
@ -1,9 +1,8 @@
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://user-images.githubusercontent.com/11247099/140462375-7b7ac4db-35b7-453c-8a05-13d8d20282c4.png" width="600"/>
|
<img src="./public/topverse.svg" width="600"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2 align="center">
|
<h2 align="center">
|
||||||
<a href="https://github.com/antfu/vitesse">Vitesse</a> for Nuxt 3
|
|
||||||
</h2><br>
|
</h2><br>
|
||||||
|
|
||||||
<pre align="center">
|
<pre align="center">
|
||||||
|
@ -12,73 +11,12 @@
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<br>
|
<br>
|
||||||
<a href="https://vitesse-nuxt3.netlify.app/">🖥 Online Preview</a>
|
<a href="https://topverse.netlify.app/">🖥 Online Preview</a>
|
||||||
<br><br>
|
<br><br>
|
||||||
<a href="https://stackblitz.com/github/antfu/vitesse-nuxt3"><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/antfu/unocss) - The instant on-demand atomic CSS engine.
|
|
||||||
|
|
||||||
- 😃 Use icons from any icon sets in Pure CSS, powered by [UnoCSS](https://github.com/antfu/unocss).
|
|
||||||
|
|
||||||
- 🔥 The `<script setup>` syntax.
|
|
||||||
|
|
||||||
- 🍍 [State Management via Pinia](https://pinia.esm.dev), see [./composables/user.ts](./composables/user.ts).
|
|
||||||
|
|
||||||
- 📑 [Layout system](./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-community/color-mode-module) - dark and Light mode with auto detection made easy with Nuxt.
|
|
||||||
- [UnoCSS](https://github.com/antfu/unocss) - the instant on-demand atomic CSS engine.
|
|
||||||
- [Pinia](https://pinia.esm.dev/) - intuitive, type safe, light and flexible Store for Vue.
|
|
||||||
- [VitePWA](https://github.com/vite-pwa/nuxt) - zero-config PWA Plugin for Nuxt 3.
|
|
||||||
|
|
||||||
## 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 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-nuxt3"><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-nuxt3/generate).
|
|
||||||
|
|
||||||
### Clone to local
|
|
||||||
|
|
||||||
If you prefer to do it manually with the cleaner git history
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx degit antfu/vitesse-nuxt3 my-nuxt3-app
|
git clone https://github.com/TOPVERSE/TOPVERSE_Official.git
|
||||||
cd my-nuxt3-app
|
cd TOPVERSE_Official
|
||||||
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
|
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in New Issue