You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
55 lines
3.1 KiB
55 lines
3.1 KiB
English | [简体中文](https://github.com/umijs/umi/blob/master/README.zh-CN.md)
|
|
|
|
# umi
|
|
|
|
[](https://codecov.io/gh/umijs/umi) [](https://npmjs.org/package/umi) [](https://circleci.com/gh/umijs/umi/tree/master) [](https://dev.azure.com/umijs/umi/_build/latest?definitionId=1&branchName=master) [](https://github.com/umijs/umi) [](https://npmjs.org/package/umi) [](https://packagephobia.now.sh/result?p=umi)
|
|
|
|
🍙 Extensible enterprise-level front-end application framework.
|
|
|
|
> Please consider following this project's author, [sorrycc](https://github.com/sorrycc), and consider starring the project to show your ❤️ and support.
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
* 🎉 **Extensible**, Umi implements the complete lifecycle and makes it extensible, and Umi's internal functions are all plugins. Umi also support plugins and presets.
|
|
* 📦 **Out of the Box**, Umi has built-in routing, building, deployment, testing, and so on. It only requires one dependency to get started. Umi also provides an integrated preset for React with rich functionaries.
|
|
* 🐠 **Enterprise**, It has been verified by 3000+ projects in Ant Financial and projects of Alibaba, Youku, Netease, 飞猪, KouBei and other companies.
|
|
* 🚀 **Self Development**, Including micro frontend library, component packaging, documentation tools, request library, hooks library, data flow, etc.
|
|
* 🌴 **Perfect Routing**, Supports both configuration routing and convention routing, while with functional completeness, such as dynamic routing, nested routing, permission routing, and so on.
|
|
* 🚄 **Future Ready**, Umi's community is also exploring new technologies. For example, modern mode, webpack @ 5, automated external, bundler less, etc.
|
|
|
|
## Getting Started
|
|
|
|
Manually,
|
|
|
|
```bash
|
|
# Create directory
|
|
$ mkdir myapp && cd myapp
|
|
|
|
# Install dependency
|
|
$ yarn add umi
|
|
|
|
# Create page
|
|
$ npx umi g page index --typescript --less
|
|
|
|
# Start development
|
|
$ npx umi dev
|
|
```
|
|
|
|
Or [Getting Started with Boilerplate](https://umijs.org/docs/getting-started).
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute. [[Contribute](https://umijs.org/docs/contributing)]. <a href="https://github.com/umijs/umi/graphs/contributors"><img src="https://opencollective.com/umi/contributors.svg?width=890&button=false" /></a>
|
|
|
|
## Feedback
|
|
|
|
| Github Issue | 钉钉群 | 微信群 |
|
|
| --- | --- | --- |
|
|
| [umijs/umi/issues](https://github.com/umijs/umi/issues) | <img src="https://img.alicdn.com/tfs/TB1KxCae9f2gK0jSZFPXXXsopXa-1125-1485.jpg" width="60" /> | <img src="https://img.alicdn.com/tfs/TB1pd1ce8r0gK0jSZFnXXbRRXXa-430-430.jpg" width="60" /> |
|
|
|
|
## LICENSE
|
|
|
|
[MIT](https://github.com/umijs/umi/blob/master/LICENSE)
|