Guide · Open source
How to use umi: what it is, install basics and key facts
Updated · written with AI from the project's own documentation and checked against our catalogue data
umi is an open-source framework for building web applications with React, published on npm as umi and licensed under MIT. This guide explains what it is, what you need before starting, and where to find the detailed instructions the project keeps outside its README. It is written for readers who already know some React and npm.
umiumijs/umi · ★ 16k · MIT Install options & downloads Quick start
- 1Check your prerequisites. Make sure Node.js and npm, or a compatible package manager, are installed on your machine.
- 2Learn the basics of React. umi builds on React, so the README assumes you already know React and npm before you start.
- 3Read the official documentation. Open https://umijs.org/ to find setup and usage guidance, since the README links out for most details.
- 4Review the launch post. Read the launch post linked from the README to understand the project's direction.
- 5Install the umi package. Use your package manager to install the package published on npm under the name umi, following the docs for current commands.
- 6Clone the repository if needed. Run git clone https://github.com/umijs/umi if you want the source code locally.
What is umi and who is it for?
umi is a framework that sits on top of React, the JavaScript library for user interfaces. Its README describes it simply as a framework in the React community, and the project is written in TypeScript.
It suits developers who already work with React and want a framework on top of it, and teams looking for an MIT-licensed, community-maintained option. It is not a good first step for complete beginners to web development, because the README assumes familiarity with React and npm.
- Good fit: React developers who want a framework layer
- Good fit: teams that need an MIT-licensed project
- Poor fit: people new to web development
- Poor fit: people who want setup steps written out in the README
What you need before you start
The source lists Node.js and npm, or a compatible package manager, as the prerequisites. You should also be comfortable with React basics, since the README does not teach them.
The README does not give version requirements, so check the official documentation for current details before installing.
- Node.js
- npm or a compatible package manager
- Working knowledge of React
Install umi from the project sources
The package is published on npm under the name umi. The README's only install-related command is a git clone of the repository, which is useful if you want to read or work with the source directly.
For project setup, the README points you to the official documentation site rather than listing install steps inline.
git clone https://github.com/umijs/umiWhere to find detailed guidance
The README links to two resources. The documentation site at umijs.org is the place for learning the framework. The launch post for version 4 release candidate describes the project's direction at that point.
Contributors can read the Contributing Guide linked from the README. The project also lists a community group for feedback and questions in the README.
- Official docs: https://umijs.org/
- Launch post: https://umijs.org/blog/umi-4-rc
- Contributing guide: https://umijs.org/docs/introduce/contributing
How umi compares with similar tools
The projects most often compared with umi are Next.js, Create React App and Remix. All of them are frameworks or tooling for building React applications.
The source does not include a feature comparison, so judge them on your own requirements. Check each project's licence, documentation and maintenance status before choosing.
- Next.js
- Create React App
- Remix
What people use it for
- Building a React web application with a framework layer on top of React
- Evaluating an MIT-licensed React framework for a team project
- Reading the source of a TypeScript-based React framework
- Contributing to an open-source project by following its contributing guide
Frequently asked questions
Is umi free to use?
umi is licensed under MIT, as stated in the README and the package's license badge. The MIT licence is a permissive open-source licence, but read the LICENSE file in the repository for its full terms.
What do I need to install umi?
The source lists Node.js and npm, or a compatible package manager, as prerequisites. The package is published on npm under the name umi.
Where is the umi documentation?
The official documentation is at https://umijs.org/. The README links to it for most setup and usage information.
Is umi good for beginners?
Not according to the README, which assumes familiarity with React and npm. Learn React basics first, then come back to umi.
What are the alternatives to umi?
The source lists Next.js, Create React App and Remix as comparable projects. Compare their licences, documentation and maintenance before picking one.
Is umi written in TypeScript?
Yes, the project's language is listed as TypeScript in its repository details.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
umi suits React developers who want an MIT-licensed, community-maintained framework and are happy to learn from the official docs. Beginners, or anyone who needs complete setup steps in the README itself, should choose a tool with more inline guidance or start with React fundamentals first.
Install options & downloads