Skip to content

Repository files navigation

Vue 3 + TypeScript 企业级开发模板

一个现代化的 Vue 3 + TypeScript 企业级开发模板,集成了最新的前端技术和最佳实践。

✨ 特性

  • ⚡️ Vue 3 - 使用 Composition API 和 <script setup> 语法
  • 🛠️ TypeScript - 完整的类型支持
  • 🚀 Vite - 快速的构建工具
  • 🎨 Element Plus - 丰富的 UI 组件库
  • 📦 Pinia - 现代化的状态管理
  • 🌐 Vue Router 4 - 路由管理
  • 🌍 Vue I18n - 国际化支持
  • 🔒 权限控制 - 路由守卫和权限管理
  • 🎯 代码规范 - ESLint + Prettier
  • 🧪 单元测试 - Vitest + Vue Test Utils
  • 📱 响应式设计 - 移动端适配
  • 🎨 主题切换 - 明暗主题支持

📦 技术栈

  • 前端框架: Vue 3.4
  • 构建工具: Vite 5.0
  • 开发语言: TypeScript 5.3
  • UI 组件库: Element Plus 2.4
  • 状态管理: Pinia 2.1
  • 路由管理: Vue Router 4.2
  • HTTP 客户端: Axios 1.6
  • CSS 预处理器: SCSS
  • 代码规范: ESLint + Prettier
  • 测试框架: Vitest + Vue Test Utils

🚀 快速开始

环境要求

  • Node.js >= 16.0.0
  • npm >= 7.0.0

安装依赖

npm install

启动开发服务器

npm run dev

构建生产版本

npm run build

代码检查

# ESLint 检查
npm run lint

# TypeScript 类型检查
npm run type-check

# 运行测试
npm run test

📁 项目结构

src/
├── api/           # API 接口
├── assets/        # 静态资源
├── components/    # 公共组件
├── locales/       # 国际化
├── router/        # 路由配置
├── stores/        # 状态管理
├── styles/        # 样式文件
├── types/         # 类型定义
├── utils/         # 工具函数
├── views/         # 页面组件
├── App.vue        # 根组件
└── main.ts        # 入口文件

🛠️ 开发指南

添加新页面

  1. src/views/ 目录下创建页面组件
  2. src/router/index.ts 中添加路由配置
  3. 如需权限控制,在路由的 meta 中设置 requiresAuth: true

添加新 API

  1. src/api/ 目录下创建对应的 API 文件
  2. 使用 request 工具发送请求
  3. 定义 TypeScript 接口类型

主题定制

  1. 修改 src/styles/variables.scss 中的 SCSS 变量
  2. 在组件中使用 CSS 变量进行主题切换

🔧 配置说明

环境变量

  • .env.development - 开发环境配置
  • .env.production - 生产环境配置

Vite 配置

  • 代理配置:vite.config.ts 中的 server.proxy
  • 构建优化:build 配置项
  • 路径别名:@ 指向 src 目录

🎯 最佳实践

代码组织

  • 使用 Composition API 和 <script setup>
  • 组件按功能模块划分
  • API 接口统一管理
  • 类型定义完整清晰

性能优化

  • 组件懒加载
  • 图片资源优化
  • 代码分割和摇树优化
  • 缓存策略配置

安全考虑

  • XSS 防护
  • CSRF 防护
  • 权限验证
  • 输入验证

🤝 贡献指南

  1. Fork 本项目
  2. 创建功能分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 创建 Pull Request

📄 许可证

本项目采用 MIT 许可证。

🙏 致谢

感谢以下开源项目的贡献:


Happy Coding! 🎉

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages