weiguanglai / vite-vue3-ts

vite、vue3、script setup、TypeScript、pinia、ant-design-vue

vite-vue3-ts

介绍

一个使用 vite + vue3 + pinia + ant-design-vue + typescript 完整技术路线开发的项目，秒级开发更新启动、新的vue3 composition api 结合 setup纵享丝滑般的开发体验、全新的 pinia状态管理器和优秀的设计体验（1k的size）、antd无障碍过渡使用UI组件库 ant-design-vue、安全高效的 typescript类型支持、代码规范验证、多级别的权限管理~

相关文章：https://juejin.cn/post/7041188884864040991

特性

• ✨脚手架工具：高效、快速的 Vite
• 🔥前端框架：眼下最时髦的 Vue3
• 🍍状态管理器：vue3新秀 Pinia，犹如 react zustand般的体验，友好的api和异步处理
• 🏆开发语言：政治正确 TypeScript
• 🎉UI组件：antd开发者无障碍过渡使用 ant-design-vue，熟悉的配方熟悉的味道
• 🎨css样式：less 、postcss
• 📖代码规范：Eslint、Prettier、Commitlint
• 🔒权限管理：页面级、菜单级、按钮级、接口级
• ✊依赖按需加载：unplugin-auto-import，可自动导入使用到的vue、vue-router等依赖
• 💪组件按需导入：unplugin-vue-components，无论是第三方UI组件还是自定义组件都可实现自动按需导入以及TS语法提示

项目目录

├── .husky                              // husky git hooks配置目录
    ├── _                               // husky 脚本生成的目录文件
    ├── commit-msg                      // commit-msg钩子，用于验证 message格式
    ├── pre-commit                      // pre-commit钩子，主要是和eslint配合
├── config                              // 全局配置文件
    ├── vite                            // vite 相关配置
    ├── constant.ts                     // 项目配置
    ├── themeConfig.ts                  // 主题配置
├── dist                                // 默认的 build 输出目录
├── mock                                // 前端数据mock
├── public                              // vite项目下的静态目录
└── src                                 // 源码目录
    ├── api                             // 接口相关
    ├── assets                          // 公共的文件（如image、css、font等）
    ├── components                      // 项目组件
    ├── directives                      // 自定义 指令
    ├── enums                           // 自定义 常量（枚举写法）
    ├── hooks                           // 自定义 hooks
    ├── layout                          // 全局布局
    ├── router                          // 路由
    ├── store                           // 状态管理器
    ├── utils                           // 工具库
    ├── views                           // 页面模块目录
        ├── login                       // login页面模块
        ├── ...
    ├── App.vue                         // vue顶层文件
    ├── auto-imports.d.ts               // unplugin-auto-import 插件生成
    ├── components.d.d.ts               // unplugin-vue-components 插件生成
    ├── main.ts                         // 项目入口文件
    ├── shimes-vue.d.ts                 // vite默认ts类型文件
    ├── types                           // 项目type类型定义文件夹
├── .editorconfig                       // IDE格式规范
├── .env                                // 环境变量
├── .eslintignore                       // eslint忽略
├── .eslintrc                           // eslint配置文件
├── .gitignore                          // git忽略
├── .npmrc                              // npm配置文件
├── .prettierignore                     // prettierc忽略
├── .prettierrc                         // prettierc配置文件
├── index.html                          // 入口文件
├── LICENSE.md                          // LICENSE
├── package.json                        // package
├── pnpm-lock.yaml                      // pnpm-lock
├── postcss.config.js                   // postcss
├── README.md                           // README
├── tsconfig.json                       // typescript配置文件
└── vite.config.ts                      // vite

效果图

更新记录

• 2022.01.18
  • 增加环境变量配置文件 .env/.env.development/.env.production
• 2022.03.09
  • 为了优化服务器构建，移除 auto-imports.d.ts、components.d.ts的git记录，加入.gitignore
  • 域名二级目录的路由配置优化 history: createWebHistory(import.meta.env.BASE_URL)
  • 路由模式由 hash调整为 history

计划

• 主题换肤功能
• 引入 tailwindcss
• ant-design-vue 升级到 3.x版本

感谢star