Environment & Installation
Environment & Installation
Section titled “Environment & Installation”Get your development environment ready and install the Verta Vue Admin Template with this comprehensive guide.
📋 System Requirements
Section titled “📋 System Requirements”Minimum Requirements
Section titled “Minimum Requirements”- Node.js: Version 20.19.0 or higher Required
- Package Manager: npm (comes with Node.js) or pnpm Recommended
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 2GB free space for dependencies
Recommended Setup
Section titled “Recommended Setup”- Node.js: Version 22.x or higher Recommended
- Package Manager: pnpm for faster installs and better disk usage
- IDE: VS Code with Vue and TypeScript extensions
- Terminal: Modern terminal with Git support
🛠 Development Tools Setup
Section titled “🛠 Development Tools Setup”Required Tools
Section titled “Required Tools”Install Node.js
Download and install Node.js LTS from nodejs.org
Verify installation:
Terminal window node --version # Should show v20.19.0 or highernpm --version # Should show npm versionInstall pnpm (Recommended)
Install pnpm globally:
Terminal window npm install -g pnpmVerify pnpm installation:
Terminal window pnpm --version # Should show pnpm versionVerify Installation
Verify that all tools are properly installed:
Terminal window node --version # Should show v20.19.0 or higherpnpm --version # Should show pnpm version
IDE Configuration
Section titled “IDE Configuration”We recommend Visual Studio Code with these essential extensions:
- Vue Language Features (Volar) - Vue 3 support with TypeScript
- TypeScript Vue Plugin (Volar) - Enhanced TypeScript experience
- Tailwind CSS IntelliSense - Autocomplete for Tailwind classes
- ESLint - Code linting and formatting
- Prettier - Code formatting
- Auto Rename Tag - Automatic HTML/Vue tag renaming
📦 Installation Process
Section titled “📦 Installation Process”Extract the Template
Extract the downloaded ZIP file to your desired location:
Terminal window # Navigate to your projects directorycd /path/to/your/projects# Extract the template (replace with actual filename)unzip verta-vue-admin-template.zipcd verta-vue-admin-templateInstall Dependencies
Install all project dependencies:
Terminal window # Using pnpm (recommended)pnpm install# Using npmnpm installVerify Installation
Check that all dependencies installed correctly:
Terminal window pnpm list --depth=0 # Lists top-level dependenciesStart Development Server
Launch the development server:
Terminal window # Using pnpmpnpm dev# Using npmnpm run devThe server will start on
http://localhost:5173
by default.
🚀 First Run
Section titled “🚀 First Run”After starting the development server:
- Open your browser to
http://localhost:5173
- Login credentials (demo mode):
- Username:
[email protected]
- Password:
password
- Username:
- Explore the dashboard and familiarize yourself with the layout
- Check the console for any warnings or errors
⚙️ Configuration
Section titled “⚙️ Configuration”Application Settings
Section titled “Application Settings”The template comes with pre-configured settings that work out of the box. Most customizations can be made through the built-in configuration files:
- Theme Configuration:
src/assets/styles/index.css
- Color schemes and design tokens - Internationalization:
src/locales/
- Language files for multi-language support - Router Configuration:
src/router/index.ts
- Application routing and navigation - Component Settings: Individual components accept props for customization
🏗 Build Configuration
Section titled “🏗 Build Configuration”Development Build
Section titled “Development Build”For development with hot reloading:
pnpm dev
Production Build
Section titled “Production Build”Build optimized files for production:
pnpm build
This creates a dist/
folder with optimized assets ready for deployment.
Preview Production Build
Section titled “Preview Production Build”Test the production build locally:
pnpm preview
Type Checking
Section titled “Type Checking”Run TypeScript type checking:
pnpm vue-tsc
🔧 Troubleshooting
Section titled “🔧 Troubleshooting”Common Issues
Section titled “Common Issues”Node.js Version Mismatch
# Check current Node.js versionnode --version
# Use Node Version Manager (if installed)nvm use 22# ornvm install 22 && nvm use 22
Port Already in Use
# Kill process using port 5173npx kill-port 5173
# Or specify different portpnpm dev --port 3000
Dependency Installation Fails
# Clear cache and reinstallpnpm store prunerm -rf node_modules package-lock.jsonpnpm install
Permission Errors (macOS/Linux)
# Fix npm permissionssudo chown -R $(whoami) ~/.npm
Getting Help
Section titled “Getting Help”If you encounter issues:
- Check the console for error messages
- Verify Node.js version meets requirements
- Clear cache and reinstall dependencies
- Check documentation for similar problems
- Contact support with detailed error information
✅ Verification Checklist
Section titled “✅ Verification Checklist”Before proceeding to development:
- Node.js 20.19+ installed and working
- pnpm or npm available
- Dependencies installed without errors
- Development server starts successfully
- Application loads in browser
- No console errors or warnings
- Hot reload working correctly