umi README

The project's README from github.com/umijs/umi. As one markdown file: README.md.

umi

Version Downloads build status License

A framework in react community ✨

Please consider following this project's author, sorrycc, and consider starring the project to show your ❤️ and support.

🚀 Read the launch post →

📚 Learn Umi →

Contribution

See Contributing Guide.

Core Maintainers

Core Maintainers are community members who have contributed significantly to the project through addressing issues, fixing bugs, and implementing enhancements/features.

Maintainers

Maintainers are community members who have had 10 or more PRs merged in umi or have spent a lot of time contributing to the umi community or addressing issues.

Contributors

Contributors are community members who have had 1 or more PRs merged in umi. If you are a contributor, you can contact me [sorrycc] to join the Contributor Group.

Umi contributors

Community

LICENSE

MIT

umi (umijs/umi)

Searching Database…

16K ·GitHub
这是什么?Umi 是 React 社区的一个框架——你在它之上构建 Web 应用,而不需要自己东拼西凑各种 React 工具。这个仓库是该框架的源码,以 pnpm + Turborepo 的 monorepo 形式开发。
它是框架还是组件库?它是框架,不是组件库:仓库里放的是框架自身的各个包,用 pnpm workspaces 和 Turborepo 管理,日常怎么用主要看它专门的文档,而不是仓库页面本身。
我该怎么上手?跟着 README 里的「Learn Umi」文档链接走——这是官方推荐的开发应用路径。如果你想改 umi 的源码本身,需要用 pnpm 初始化这个仓库(Node >= 14,pnpm ^8.15.9)。
用它的前提是我得装好哪些东西?Node 14 或更新版本,以及 pnpm ^8.15.9,这两个都写在仓库的 engines 里;构建通过它的 umi-scripts 和 Turborepo 工具链完成。不涉及 Python 或 Go 之类的其他技术栈。
这份 README 有没有讲清楚这个框架到底能做什么?基本没有——除了一句话简介,它只讲贡献方式、维护者和社区。功能文档都在「Learn Umi」和发布公告的链接里,所以判断 umi 还是得看它的文档。
它的社区是纯中文的,还是对英文用户也友好?README 是英文的,但它链接的社区聊天群是中文群(「交流和反馈群」),所以这个项目周边的生态基本是中文环境。
umi 还在积极维护吗?从这里的各种迹象看是在维护的:它从 2017 年 11 月开发至今,在 GitHub 上约有 16,000 颗星,没有被归档,还跑着多条 CI 流水线,包括多套端到端测试。
它的测试覆盖得够不够充分?它的 CI 会跑端到端测试,覆盖基础环境、各种脚手架模板和 MFSU,另外还有覆盖率检查和压缩体积(打包体积)检查。
umi 是一个人的项目吗,押注在它上面靠谱吗?它的底蕴不止一个人:README 列出了三位核心维护者(sorrycc、xiaohuoni、fireairforce),还有一批各自合并过 10 个以上 PR 的维护者,以及一个开放的贡献者群体。
What are similar projects?taro, refine, nextra, react-router, woocommerce, next.js, svelte, wxt
Creator
umijs
Size
198 MB
Stars
16K
Age
8y
Commits · 90 Days