wswmsword/vulcan

🔥The Template for Mobile Application, Vite4&Vue3, Pinia, Router, APIs&Mock, I18n, Unit&E2E Test.移动端Web应用模板

Vulcan

🚀🚀The Project Template for Vite + Vue3， Mobile Web Application Starter。🚀🚀

Live Demo

English | 中文

Feature

• ⚡️ vue 3, vite 4, pnpm, esbuild - fast! fast! fast!
• 🦾 Typescript
• 📦 Component Auto Import
• 🍍 pinia - State Management
• 🔥 <script setup> syntax
• 🌍 i18n Support Internationalization
• 📥 APIS Auto Import - composition API and other directory
• ⚙️ Unit test with Vitest , E2E test withCypress
• 🎨 postcss / sass
• 📒 axios encapsulation - Better to API management, APIs code is docs
• 📬 API Mock Data - Mock-Dev-Server
• ⚖️ px to viewport
• 📐 eslint / prettier
• ⏳ git hooks - format git commit

Pre-packed

Plugin

• Vue-Router - Router system
• Pinia - State management
• Vue-i18n - Internationalization
  • @intlify/unplugin-vue-i18n - Vite plugin for vue-i18n
• VueUse - Composition APIs
• axios - http
• js-cookie - Cookie Management
• unplugin-vue-components - Component Auto Import
• unplugin-auto-import - APIs and other directory without Import
• vite-plugin-inspect - Module Deps Inspect
• vite-plugin-vconsole - Import vconsole
• vite-plugin-mock-dev-server - Http request mock dev server

Coding Style

• prettier
• eslint - use @pengzhanbo/eslint-config config， single quotes, no semi
• <script setup> SFC syntax

Dev Tools

• Typescript
• Vitest - Unit testing powered by vite
• Cypress - E2E testing
• pnpm - package manager, fast and disk space efficient
• husky, lint-staged, commitizen - git hooks，format commit
• postcss, sass CSS
  • autoprefixer
  • postcss-px-to-viewport-8-plugin - px to viewport
• unocss

Try It Now！

vulcan need node version >= 14.18

Clone To Local

npx degit pengzhanbo/vulcan my-vulcan-app
cd my-vulcan-app
pnpm i

Checklist

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

• Change the author name in LICENSE
• Change the name in package.json
• Delete the uncalled for DEMO files
• Delete the uncalled for Router
• clear up the README

Usage

development

run and visit localhost:8080/

pnpm dev

Build

To build App, run

pnpm build

The built files will be generated in dist directory.

Browser Support

IE	Edge	Firefox	Chrome	Safari
not support	last 2 versions	last 2 versions	last 2 versions	last 2 versions

Archives

awesome-vite

LICENSE

MIT