Piral ·
轻松构建使用微前端的下一代Web应用程序。Piral使您能够创建一个模块化的前端应用程序,该应用程序可在运行时通过称为pilets的解耦模块进行扩展,利用微前端架构。
pilet可以独立开发,并附带必要的代码以及所有其他相关资产。pilets可以根据您的需求与主机应用程序保持独立,使其可在不同应用程序之间转移。
这使得Piral成为由分布式团队开发的中型到大型应用程序的理想基础。
:zap: pilet能够动态地扩展其他pilets或自身使用这种扩展插槽。
:zap: pilet可以提供或使用来自其他pilets的共享依赖项。 :zap: pilet 是隔离的(开发和处理),绝不会破坏你的应用程序。
:zap: pilet 可以使用任何技术在标准 IDE 中开发。
:zap: pilet 可以在几秒钟内更新和发布。
:zap: pilet 可以动态推出或禁用,以创建自组织应用程序。
:zap: pilet 可以无缝调试,就像编写单体应用一样。
重要链接
- 📢 我们正在招聘! - 与我们一起开发 Piral、其生态系统和服务用户
- 🌍 网站 - 了解更多关于 Piral 的信息
- 📖 文档 - 开始使用和掌握微前端的所有内容
- 🉐 帮助翻译 Piral! - 在 documentation 分支提交 PR
- 🐞 问题追踪 - 报告错误或提出新功能建议
- 🗨 论坛 - 在 StackOverflow 上获取社区支持
- 👪 社区聊天 - 在我们的 Discord 服务器上提问和解答
入门
Piral 本身是作为一个 monorepo 开发的。因此,这个仓库可能包含大量信息。
我们建议从 docs.piral.io 上的文档开始。学习可用的教程将以最佳顺序为你提供必要的信息。
问题
虽然GitHub issues可用于提问,但我们更希望一般使用问题能在我们的 Discord 服务器或StackOverflow上提出。
贡献
这个仓库的主要目的是继续发展 Piral 及其核心生态系统,使其更快、更强大、更易于使用。Piral 的开发在 GitHub 上公开进行,我们感谢社区贡献错误修复、想法和改进。
阅读以下内容,了解如何参与改进 Piral。
仓库结构
docs
包含(用户)文档src
包含所有开发包、示例和页面的源代码test
包含测试设置和(将来的)系统测试tools
包含用于构建不同组件的一些内部工具
每个子目录都包含另一个 README.md
,其中提供了有关特定文件夹内容的更多信息。
行为准则
我们采用了一份行为准则,我们希望项目参与者遵守。请阅读完整文本,以了解哪些行为会被允许,哪些行为不会被容忍。
贡献指南
阅读我们的贡献指南,了解我们的开发流程、如何提出错误修复和改进建议,以及如何构建和测试你对Piral的修改。
适合新手的议题
为了帮助你入门并熟悉我们的贡献流程,我们列出了一系列适合新手的议题,这些议题包含范围相对有限的bug。这是一个很好的起点。
许可证
Piral采用MIT许可证发布。有关更多信息,请参阅许可证文件。