spaxjs / spax

[WIP] :rocket: a framework for building frameworks

🚀 spax

✊ 使用 React、TypeScript，可扩展、插件化、渐进式，满足各种规模的业务开发。

☕ 立即使用 StarterKit

执行以下命令：

$ npx @spax/spax-cli <project-name>

马上开始一段奇妙的旅程。

📖 名词解释 Glossary

• 引擎：特指 @spax/core
• 框架
  • 基础框架：@spax/framework
  • 业务框架：基础框架的子类，比如 @spax/framework-simple
• Block：业务模块声明，可能包含 path, component 等信息

📌 设计原则 Principle

• 可扩展
  • 核心框架仅提供必要的插件与模块管理能力，其它技术栈不做限制。
• 插件化
  • 围绕插件初始化、模块解析、组件渲染等钩子函数，开发功能插件。
• 渐进式
  • 业务框架演进路径：糅合于业务 -> 抽象成插件 -> 沉淀到框架。

🔩 插件 Plugins

• @spax/plugin-lazy 支持异步组件
• @spax/plugin-path 规范化模块路由地址
• @spax/plugin-router 提供路由支持

🗃️ 框架 Frameworks

• @spax/framework 框架基类
• @spax/framework-simple 基础框架，集成常见插件

🎇 示例 Examples

以下示例使用的技术栈非必选，实际应用时可根据自身偏好灵活调整。

• demo

  • react-scripts
  • react-app-rewired
  • customize-cra

• demo for single-spa

  • react-scripts
  • craco
  • single-spa