@volverjs/ui-vue-starter

Inspired by Vitesse ❤

vue volverjs ui vue3 vite template starter
components component-library

maintained with ❤️ by

Features

• ⚡️ Vue 3, Vite, pnpm, esbuild - born with fastness

• 🗂 File based routing

• 📦 Components auto importing

• 🍍 State Management via Pinia

• 📲 PWA

• 🎨 @volverjs/ui-vue

• 🌍 I18n ready

• 🔥 Use the new <script setup> syntax

• 📥 APIs auto importing - use Composition API and others directly

• 🦾 TypeScript, of course

Pre-packed

Volverjs UI Vue

• @volverjs/ui-vue - The lightweight Vue 3 component library

Plugins

• Vue Router
  • vite-plugin-pages - File system based routing
• Pinia - Intuitive, type safe, light and flexible Store for Vue using the composition api
• unplugin-vue-components - Components auto import
• unplugin-auto-import - Directly use Vue Composition API and others without importing
• vite-plugin-pwa - PWA
• Vue I18n - Internationalization
  • unplugin-vue-i18n - Unplugin for Vue I18n
• VueUse - Collection of useful composition APIs
• @vueuse/head - Manipulate document head reactively

Coding Style

• Use Composition API with <script setup> SFC syntax
• ESLint with typescript and vue3 recommended
• Stylelint with recommended rules
• Prettier with single quotes, no semi, trailing comma and four spaces of tab width

Dev tools

• TypeScript
• pnpm - Fast, disk space efficient package manager
• VS Code Extensions
  • Volar - Vue 3 <script setup> IDE support
  • Iconify IntelliSense - Icon inline display and autocomplete
  • i18n Ally - All in one i18n support
  • ESLint
  • Prettier
  • Stylelint

Try it now!

@volverjs/ui-vue-starter requires Node >=14.18

GitHub Template

Create a repo from this template on GitHub.

Clone to local

If you prefer to do it manually with the cleaner git history

npx degit volverjs/ui-vue-starter my-app
cd my-app
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm

Checklist

When you use this template, try follow the checklist to update your info properly

• Change the author name in LICENSE
• Update package.json with your info
• Change the title in App.vue
• Change the favicon in public
• Clean up the READMEs and remove routes

And, enjoy :)

Usage

Development

Just run and visit http://localhost:8080

pnpm dev

Build

To build the App, run

pnpm build

And you will see the generated file in dist that ready to be served.

Acknoledgements

This repo is inspired by 🏕 antfu/vitesse

License

MIT