Skip to content

Micro-Frontend boilerplate(TS Lib, TS CLI Lib, React App Lib, React Component Lib) with React & TypeScript & Vite, for complicated cooperative applications. | 微前端项目模板

License

Notifications You must be signed in to change notification settings

wx-chevalier/vite-examples

Repository files navigation

m-fe/libs

Web 开发导论/微前端与大前端一文中,笔者简述了微服务与微前端的设计理念以及微前端的潜在可行方案。微服务与微前端,都是希望将某个单一的单体应用,转化为多个可以独立运行、独立开发、独立部署、独立维护的服务或者应用的聚合,从而满足业务快速变化及分布式多团队并行开发的需求。如康威定律(Conway’s Law)所言,设计系统的组织,其产生的设计和架构等价于组织间的沟通结构;微服务与微前端不仅仅是技术架构的变化,还包含了组织方式、沟通方式的变化。微服务与微前端原理和软件工程,面向对象设计中的原理同样相通,都是遵循单一职责(Single Responsibility)、关注分离(Separation of Concerns)、模块化(Modularity)与分而治之(Divide & Conquer)等基本的原则。

微前端项目结构

当我们考量项目框架、模板或者脚手架的时候,首先想到的点就是希望尽可能对上层屏蔽细节,但是对于长期维护的、多人协作的中大型项目而言,如果项目的主导者直接使用了部分抽象的脚手架,不免会给未来的更新、迭代带来一定的技术负债;同时,目前也有很多成熟的工程化脚手架,因此笔者选择以项目模板的形式抽象出微前端中所需要的部分。尽可能地遵循简约、直观的原则,减少抽象/Magic Function 等;大型项目可能会抽象出专用的开发工具流,但是对于大部分项目而言,在现有框架/工具链的基础上进行适当封装会是较优选择。

Develop

# 拉取并且提取出子项目
$ git clone https://github.com/wx-chevalier/m-fe-rtw

# 添加全局的依赖更新工具
$ yarn global add npm-check-updates npm-run-all cross-env copyfiles

# 为各个子项目安装依赖,以及链接各个子项目
$ yarn bootstrap && yarn build

# 执行预编译操作
$ yarn start

# 执行 Lint 操作
$ yarn lint

值得说明的是,微前端作为概念对于不同人承载了不同的考量,其实现方式、落地路径也是见仁见智,若有不妥,敬请指教。

Features

  • 状态管理,灵活支持 Redux/MobX/Dva 等不同的状态管理框架,对于 Redux 提供全局统一的 Store 声明。

  • 模块分割,非 APP 类可单独发布,APP 类可单独运行,与发布。发布版本可包含 ES, CJS, UMD 等,dist 目录下包含 ES/CJS 模块,build 目录下包含 APP 完整资源以及 UMD 模块。

  • 应用编排:版本控制、应用注册、应用路由,子应用资源不使用 Hash 方式,而是使用语义化版本,/[cdnHost]/[projectName]/[subAppName]/[x.y.z]/index.{js,css}

  • 动态主题与样式切换,- 样式,LESS 文件支持 CSS Modules,CSS/SCSS 使用标准 CSS。

  • 权限控制

  • 路由与导航框架

  • 国际化

  • PWA

  • 服务端渲染

CI

m-fe-rtw 内置了 Gitlab CI 的完整流程,请参考 .gitlab-ci.yml 及 scripts/{deploy, docker} 中的配置。

Nav | 关联项目

  • m-fe-configs:Common Dev Configs(ESLint, Prettier, Husky, etc.) for Micro-Frontend Apps

  • m-fe-rtw: Micro-Frontend boilerplate with React & TypeScript & Webpack, for complicated cooperative applications. | 微前端项目模板

  • m-fe-vtw: Micro-Frontend boilerplate with Vue & TypeScript & Webpack, for complicated cooperative applications. | 微前端项目模板

  • m-fe-rm: 基于 React & TS & Webpack & APICloud 提供快速移动端应用开发的能力

  • m-fe-taro: 基于 Taro & TS 的多端小程序开发模板。

  • m-fe-scaffold: Cli Toolkits for Web Development & Deploy on Kubernetes,微前端实践中沉淀的一系列脚手架工具。

  • m-fe-libs: Micro-Frontend boilerplate with React & TypeScript & Webpack, for complicated cooperative applications. | 微前端项目模板

--

  • react-snippets: React Snippets(.ts/.tsx), about design patterns/techniques used while developing with React and TypeScript.

  • vue-snippets: Vue Snippets(.js/.ts), about design patterns/techniques used while developing with Vue and JavaScript/TypeScript.

  • fractal-components: Massive Fractal Components in Several Libraries(Vanilla, React, Vue, Weapp), for building your great apps easily again

  • Legoble: Build your apps like stacking Lego blocks 💫 总想自己实现一款可视化配置的动态应用构建工具,动态表单、动态布局、动态报告、动态规则、动态选择、动态流程

About

Copyright & More | 延伸阅读

笔者所有文章遵循 知识共享 署名-非商业性使用-禁止演绎 4.0 国际许可协议,欢迎转载,尊重版权。您还可以前往 NGTE Books 主页浏览包含知识体系、编程语言、软件工程、模式与架构、Web 与大前端、服务端开发实践与工程架构、分布式基础架构、人工智能与深度学习、产品运营与创业等多类目的书籍列表:

NGTE Books

About

Micro-Frontend boilerplate(TS Lib, TS CLI Lib, React App Lib, React Component Lib) with React & TypeScript & Vite, for complicated cooperative applications. | 微前端项目模板

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published