/micro-framework

基于 WebComponent 的微前端框架示例

Primary LanguageTypeScriptMIT LicenseMIT

Micro Framework

CI Status CD Status Coverage Status npm

Micro Framework 是《深入浅出微前端》小册衍生出来的一个微前端示例框架。

特性

  • 基于 single-spa 进行封装
  • 基于 iframe 进行隔离设计
  • 提供 Loader 的扩展机制
  • ...

安装

# CommonJS 库包安装
npm i ziyi-micro-framework --save

# ES Module 库包安装
npm i ziyi-micro-framework-es -save

使用

暂无使用方法,正在设计中...

贡献指南

如果该微前端框架代码存在优化空间,希望大家可以指正。可以通过提 Issues 的形式告知,也可以通过 Pull Request 的形式提交指正代码,作者会对代码进行 Review,如果通过会合并大家的代码,也可能告诉大家为什么不能接受这样的修改,并最终关闭它。

在提交一个 Pull Request 之前,请确保你按照以下的步骤来做:

  • Fork 仓库
  • 创建分支进行修改
  • 使用 Angular 规范的提交说明
  • 更新源码的同时更新相应的 VuePress 说明文档
  • 确保代码通过 CI 流程

许可协议

MIT

Copyright (c) 2023-present ziyi