{"id":25227774,"url":"https://github.com/ibwei/vue3-ts-base","last_synced_at":"2025-04-05T16:08:13.333Z","repository":{"id":39305532,"uuid":"292768798","full_name":"ibwei/vue3-ts-base","owner":"ibwei","description":"一个基于vue3+typescript+ant-design-vue 搭建的基础代码库,有完善的类型系统，帮助快速搭建 vue3 的基础代码架构。","archived":false,"fork":false,"pushed_at":"2021-04-07T03:06:16.000Z","size":8679,"stargazers_count":441,"open_issues_count":2,"forks_count":128,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-04-24T16:36:50.033Z","etag":null,"topics":["ant","vue","vue3","vue3-ant","vue3-demo","vue3-tsx","vue3-typescript"],"latest_commit_sha":null,"homepage":"https://ibwei.github.io/vue3-ts-base/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ibwei.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-04T06:31:49.000Z","updated_at":"2024-03-01T02:06:43.000Z","dependencies_parsed_at":"2022-07-14T19:30:43.963Z","dependency_job_id":null,"html_url":"https://github.com/ibwei/vue3-ts-base","commit_stats":null,"previous_names":["ibwei/vue3-base"],"tags_count":10,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibwei%2Fvue3-ts-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibwei%2Fvue3-ts-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibwei%2Fvue3-ts-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibwei%2Fvue3-ts-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ibwei","download_url":"https://codeload.github.com/ibwei/vue3-ts-base/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361689,"owners_count":20926643,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ant","vue","vue3","vue3-ant","vue3-demo","vue3-tsx","vue3-typescript"],"created_at":"2025-02-11T09:09:57.643Z","updated_at":"2025-04-05T16:08:13.301Z","avatar_url":"https://github.com/ibwei.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 项目基础代码架构说明\n\n- 如果对你有帮助的话，欢迎star\n- demo 演示地址:[https://ibwei.github.io/vue3-ts-base/](https://ibwei.github.io/vue3-ts-base/)  \n#### 包管理工具\n\n- 建议使用 yarn,也是 vue-cli4.0+ 默认工具\n  \n#### 主要用到的库\n\n- vue 全家桶 vue3 + vue-router + vuex + typescript\n- http 请求:axios\n- ui 库:ant-design-vue.\n- 提交规范:git cz commitizen\n- 版本更改历史: changelog\n- 文档工具:typedoc\n- 代码检查:eslint+eslint-typescript,格式化:prettier.提交之前检查与修复：lint-staged\n- 测试用例:mocha,ts-node\n- webpack 插件:style-resources-loader（全局 less）webpack-bundle-analyzer（包分析工具） splitChunks（代码分离）\n\n#### 代码基础架构说明\n\n```\n|-- 根目录\n    |-- dist 项目 build 之后的文件夹\n    |-- docs 文档生成的根目录位置\n    |-- public 项目静态资源，不经过 webpack，以及默认的模版，适合存放第三方压缩好的资源\n    |-- src 主要的开发目录\n    | |-- @types 项目共用的 type\n    | |-- App.vue 页面渲染根节点\n    | |-- main.ts 入口文件\n    | |-- shims-vue.d.ts vue 文件类型的 type\n    | |-- api http 请求相关\n    | | |-- apiList.ts api 接口列表\n    | | |-- axios.ts 业务请求封装\n    | | |-- editor.ts 其他业务封装\n    | | |-- user.ts api 请求模块\n    | |-- assets 存放静态资源，这个文件夹下的文件会走 webpack 压缩流程\n    | |-- components\n    | | |-- index.ts 自动注册脚本\n    | | |-- global 自动注册的全局组件\n    | | |-- ...其他非全局注册的模块\n    | |-- config 全局静态配置，不可更改项\n    | |-- layout 页面页面骨架\n    | |-- plugins 存放第三方插件\n    | | |-- index.ts 插件挂载入口\n    | |-- router 路由\n    | | |-- index.ts 路由入口\n    | |-- store vuex\n    | | |-- modules 多个模块\n    | | |-- index.ts 自动装载模块\n    | | |-- app app 模块\n    | |-- styles 全局样式，一句 ui 库主题样式\n    | | |-- \\_variables.less\n    | | |-- test.less\n    | |-- utils 常用函数以及其他有用工具\n    | | |-- common.ts\n    | |-- views 页面级组件\n    | |-- Home.vue 正常页面\n    | |-- test 组件测试页面\n    | |-- Test.vue\n    |-- tests 测试用例\n    |-- api api 模块\n    |-- unit 单元测试\n    |-- .czrc 提交规范选项设置\n    |-- .editorconfig vscode 编辑器 设置\n    |-- .env.development 开发环境配置\n    |-- .env.preview 测试环境配置\n    |-- .env.production 生产环境配置\n    |-- .eslintignore eslint 要忽略的文件夹\n    |-- .eslintrc.js eslint 规则配置\n    |-- .gitattributes github 语言选项设置\n    |-- .gitignore git 忽略的文件\n    |-- .gitlab-ci.yml gitlab CI/CD 配置\n    |-- .prettierrc.js 格式化插件配置\n    |-- CHANGELOG.md 版本更改说明\n    |-- Dockerfile 如果需要容器部署\n    |-- README.md 项目说明\n    |-- babel.config.js babel 设置\n    |-- global.d.ts 全局的 type\n    |-- package.json npm 配置\n    |-- tsconfig.json typescript 配置\n    |-- typedoc.json 文档配置文件\n    |-- vue.config.js vue-cli 脚手架配置文件\n```\n\n#### 组件编写\n\n- [x] 支持 tsx 方式编写页面,在.tsx 文件或者 class-component 里写 tsx.\n- [x] 支持 class-component 写法.\n- [x] 同时支持(.vue|.tsx.|.ts) 编写页面,defineComponent 以及 class-componnet 都支持智能提示.\n\n#### 样式配置\n\n\u003e 均通过在 vue-cli 中配置 webpack 实现.\n\n- [x] 自动注入全局样式\n- [x] 配置全局 less 变量\n- [x] 支持自定义 UI 库的主题颜色\n\n#### 网络请求\n\n- [x] 基于 axios 封装脱离具体业务逻辑的网络请求,支持编写脱离浏览器环境的测试用例.(跟业务无关)\n- [x] 基于具体业务逻辑再次封装网络请求 (跟业务相关,此项需要依据具体后台应用接口编写)\n\n#### 数据状态管理\n\n- [x] 建立应用数据状态管理\n- [x] 编写更加简易读取的mutation方法,并完善 type 【新增】\n- [x] 支持多个模块,以及自动装载模块\n- [x] 支持持久化\n\n#### UI 库\n\n- [x] 添加 ant-design-vue,支持组件按需加载\n- [x] 将 UI 库部分功能如 message 添加到每个组件实例\n\n#### 插件与常用工具函数\n\n- [x] 引用常用工具函数\n- [x] 常用 hook \n\n#### 配置\n\n- [x] 配置 webpack,分离开发/测试/生产环境配置.\n- [x] 添加 webpack 常用插件,优化打包配置.\n- [x] 根据环境配置 vue-cli 环境变量(环境相关)\n- [x] 配置应用全局静态常量(业务相关)\n- [x] 完成 tsconfig 相关配置\n- [x] 增加编辑器配置\n\n#### 开发工具\n\n- [x] eslint 代码检查,配置 prettier 格式化工具,使检查规则和格式化规则一致\n- [x] 新增提交规范 git cz commitizen,统一代码提交规范\n- [x] 为没有 type 的库和变量添加 shims\n\n#### CI/CD\n\n- [x] 配置自动构建/持续集成配置文件(与部署相关,需结合到具体项目部署情况)\n\n#### 文档\n\n- [x] 使用 TYPEDOC 搭建项目文档应用\n- [x] 在提交规范的基础上,增加版本更改历史,自动生成 changelog\n- [x] 配置 http-server 启动文档应用\n\n#### 测试用例\n\n- [x] 支持编写 js,ts 的测试用例\n\n## 安装依赖\n\n```\nyarn install\nnpm install\n```\n\n### 开发模式\n\n```\nyarn serve\nnpm run serve\n```\n\n### 生产环境\n\n```\nyarn build\nnpm run build\n```\n\n### 测试用例\n\n- api 模块开发环境下单元测试\n\n```\nnpm run test-dev:api\n```\n\n- api 模块常规单元测试\n\n```\nnpm run test:api\n```\n\n- 查看打包结果分析\n  \n``` \nnpm run analysis\n```\n### 更多问题\n\n如果有问题，请提 issue 说明 =\u003e [传送门](https://github.com/ibwei/vue3-base).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibwei%2Fvue3-ts-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fibwei%2Fvue3-ts-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibwei%2Fvue3-ts-base/lists"}