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
What is this?Umi is a framework in the React community — you build a web app on top of it instead of assembling React tooling yourself. This repo is the framework's source, developed as a pnpm + Turborepo monorepo.
Is it a framework or a component library?It's a framework, not a component kit: the repo holds the framework's own packages, managed with pnpm workspaces and Turborepo, and day-to-day usage is taught in its dedicated docs rather than on the repo page.
How do I get started with it?Follow the 'Learn Umi' docs link in the README — that's the intended path for building apps with it. To work on umi's source itself, bootstrap the repo with pnpm (Node >= 14, pnpm ^8.15.9).
What do I need to have installed to work with it?Node 14 or newer and pnpm ^8.15.9, both pinned in the repo's engines; builds run through its umi-scripts and Turborepo toolchain. No other stacks like Python or Go are involved.
Does this README explain what the framework can actually do?Not really — beyond the one-line description it only covers contribution, maintainers and community. Feature docs live behind the 'Learn Umi' and launch-post links, so judge umi by its docs.
Is the community around it Chinese-only, or English-friendly?The README is in English, but the community chat it links is a Chinese-language group ('交流和反馈群', an exchange and feedback group), so expect a largely Chinese-speaking ecosystem around the project.
Is umi still actively maintained?All signals here say yes: it has been developed since November 2017, has about 16,000 GitHub stars, is not archived, and runs several CI pipelines including multiple end-to-end suites.
How thoroughly is it tested?Its CI runs end-to-end suites covering the basic setup, boilerplates and MFSU, plus coverage and compressed-size (bundle size) checks.
Is umi a one-person project, or is it safe to bet on?It has depth beyond one person: the README names three core maintainers (sorrycc, xiaohuoni, fireairforce), a wider layer of maintainers with 10 or more merged PRs each, and an open contributor group.
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