README.en-US.md

Live Demo

UniAPP version of Vitesse-lite

简体中文 | English

Environment configuration Copy From Vitesse-lite, Strive for a development experience good environment configuration.

Features

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

• 🗂 File based routing

• 📦 Components auto importing

• 📑 Layout system

• 🍍 State Management via Pinia

• 🎨 UnoCSS - The instant on-demand atomic CSS engine.

• 😃 Use icons from any icon sets in Pure CSS

• 🔥 Use the new <script setup> style

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

• ✅ Use Vitest for unit and components testing

• 🦾 TypeScript, of course

• 🔒︎ Lock the pnpm package manager

• ☁️ Deploy on Netlify, zero-config

If there is no cross-end requirement, Vitesse-lite is recommended

Usage Notes

[email protected] and later are not specifically compatible with UniApp, you can install the version before [email protected], or use the vite-plugin-uni-polyfill plugin for simple compatibility.

But the applet side still has some APIs that are not supported even if it is compatible, so you need to judge and handle them yourself.

Pre-packed

UI Frameworks

• UnoCSS - The instant on-demand atomic CSS engine.

Icons

• Iconify - use icons from any icon sets 🔍Icônes

• Pure CSS Icons via UnoCSS

Test Framework

• Vitest - Unit testing powered by Vite

Plugins

• Pinia - Intuitive Vue.js state management library

• unplugin-auto-import - Directly use Vue Composition API and others without importing

• unplugin-vue-components - components auto import

• vite-plugin-vue-devtools - Designed to enhance the Vue developer experience.

• @areschang/utils - Personal common tool functions

• uni-use-router - UniApp routing jump supplement function library, close to Vue Router syntax

• VueUse - Vue 3 Composition API utility library

• uni-helper org

  • vite-plugin-uni-pages - file system based routing

  • vite-plugin-uni-layouts - layouts for pages

  • uni-types - UniApp Type enhance

  • unocss-preset-uni - UnoCSS UniApp preset，Fixed Windows Frequent platform crashes #3603

    • unocss-applet - UnoCSS applets preset, compatible with the use of 'Attributify Mode' in applets

  • eslint-config - Antfu ESLint configuration for UniApp

  • uni-use - UniApp utility function library based on VueUse

Coding Style

• Use Composition API with <script setup> SFC syntax
• ESLint with @antfu/eslint-config, single quotes, no semi.

Try it now!

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 ares-chang/uni-vitesse my-uni-app
cd my-uni-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
• Change the project name, description, appid in manifest.json
• Change the icon in public
• Clean up the README and delete the demo pages and components

Now enjoy your new project! :)

Run

Refer to uni-app official documentation：运行、发布uni-app