Skip to content

What is VUP

VUP is a modern development toolkit designed to provide a unified development experience for various frontend frameworks and tools. It follows the principle of "convention over configuration" and provides out-of-the-box solutions for rapid development.

Core Philosophy

⚡ Convention over Configuration

VUP follows the principle of "convention over configuration", providing sensible defaults and best practices out of the box. Developers can focus on business logic without spending time on complex configuration.

🚀 Out-of-the-Box

VUP provides pre-configured development environments, build tools, and code quality tools, allowing developers to start coding immediately after project creation.

📏 Unified Standards

VUP establishes unified development standards across all templates, ensuring consistency in code style, project structure, and development workflows.

🎨 Unified Style

VUP uses Tailwind CSS and SCSS as the unified style system, providing consistent design language and responsive design capabilities.

🔧 VSCode Plugins and Formatting Presets

VUP recommends essential VSCode plugins and provides formatting presets to improve development efficiency and code quality.

🏗️ Monorepo Architecture

VUP adopts a Monorepo architecture, providing the following advantages:

  • Unified Management - Manage multiple applications in a single repository
  • Shared Dependencies - Share common dependencies and configurations
  • Independent Deployment - Deploy each application independently
  • Team Collaboration - Improve team collaboration efficiency
  • Code Reuse - Easily share code between applications

Technical Specifications

🏗️ Monorepo Technology Stack

VUP's Monorepo architecture is based on the following technology stack:

  • pnpm Workspace - Package and dependency management
  • TypeScript - Unified type system
  • ESLint + Prettier - Unified code standards
  • Tailwind CSS - Unified style system
  • Vite - Fast build tool
  • Git - Version control and collaboration

🛠️ Development Tools

All templates come pre-configured with unified development tools:

  • Prettier - Code formatting
  • ESLint - Code quality checking
  • EditorConfig - Editor configuration
  • Auto-formatting - Format on save

Available Templates

VUP provides a rich set of templates covering various development scenarios. Users can add the required templates to their projects using the vup add command, and the system will prompt for template selection.

Frontend Templates

  • Vue SPA - Vue 3 + TypeScript + Vite + Vue Router + Pinia
  • Nuxt 3 - Full-stack Vue framework with SSR/SSG support
  • VitePress - Static site generator for documentation
  • UniApp - Cross-platform development for H5, Mini Programs, and App
  • Capacitor - Native mobile app development with web technologies
  • WXT - Browser extension development framework

Backend Templates

  • NestJS - Node.js backend framework with TypeScript

Development Tools

  • Component Library - Vue 3 component library development
  • CLI Tool - Command-line tool development with TypeScript

Getting Started

To get started with VUP, please refer to the Getting Started Guide.