@mijadesign/mjui-react-taro/README.md

京东风格的轻量级移动端 React 组件库，支持一套代码生成 H5 和小程序

## Features

* 🚀 70+ High Quality Components
* 📖 Based on JD APP 11.0 Visual Specifications
* 🍭 Support Tree Shaking
* 📖 Extensive Documentation and Demos
* 💪 Written in TypeScript
* 💪 Support SSR (Experimental)
* 🍭 Support Custom Themes
* 🍭 90%+ Unit Test Coverage
* 📖 Provide Sketch Design Resources

## script
```sh
node scripts/generate-nutui.js
node scripts/create-theme-typings.js
# 生成 nutui.react.es.js nutui.react.umd.js
vite build --config vite.config.build.ts
# 生成 esm 文件夹下的 JS 文件
npm run build:es
# 生成 packages 文件夹下的 scss 文件
npm run build:css
npm run build:loader-style
npm run build:component:css
npm run build:locales
node scripts/add-comments-to-dts.js
```

## Running locally

### running with H5
```sh
# Clone repository
git clone https://github.com/jdf2e/nutui-react.git

# Enter the project dictionary
cd nutui-react

# Install dependencies
pnpm install

# Start development
pnpm run dev

# visit in browser: http：http://localhost:3000 (you don't have to open it manually if you've run it in the browser again)
```
### running with mini-program
```sh
# Clone repository
git clone https://github.com/jdf2e/nutui-react.git

# Enter the project dictionary
cd nutui-react

# Install dependencies
pnpm install

# Start development
# dir：src/sites/mobile-taro/dist/weapp
pnpm run dev:taro:weapp

# OR run as jd mini-program
# dir：src/sites/mobile-taro/dist/jd
pnpm run dev:taro:jd
```

## Build Versions

> If you are using AMD environment or build tools such as Webpack, Vite, etc., we recommend using the `es` version. If it is a non-module environment (such as direct reference through the `<script>` tag), it is recommended to use the `umd` compressed version.

* es **nutui.es.js**

* umd **nutui.umd.js**



## Communication

| Version | WeChat Group | JD Dongdong Group |
| --- | --- |--- |
| [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> Reply 「NutUI-React」 after following | 1025679314 |
| [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" />Reply 「NutUI-React」 after following | 1022545110 |


## Join Us

#### NutUI Community

[*Welcome To NutUI-React  Community*](https://github.com/jdf2e/nutui-react/discussions/348)

#### Contribute to NutUI

There are some choices of contributing to NutUI as follows, solving issues, fixing bugs, adding new components, i18n, UI customization, platform and cross-end adaptation, etc.

You are very welcome to contribute code to NutUI. Before your pull requests, please read [*NutUI Developer Contributing Guide*](https://github.com/jdf2e/nutui-react/discussions/348)。


## Issue & Discussion

[Report issues to NutUI](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui-react&lang=zh-cn)

> It is highly recommended to read [*How To Ask Questions The Smart Way*](https://github.com/ryanhanwu/, [*How To Ask Questions Of GitHub Community*](https://github.com/seajs/seajs/issues/545) and [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.

[NutUI Discussion](https://github.com/jdf2e/nutui-react/discussions)

If you have any ideas, questions or suggestions, you can share your opinions here.

## Contributors

Thanks to all the following [developers](https://github.com/jdf2e/nutui-react/graphs/contributors)。 who have contributed code to NutUI.


<a href="https://github.com/jdf2e/nutui-react/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" alt="contributors"/>
</a>


## Stargazers 

[![Stargazers repo roster for @jdf2e/nutui-react](https://reporoster.com/stars/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/stargazers)

## Forkers

[![Forkers repo roster for @jdf2e/nutui-react](https://reporoster.com/forks/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/network/members)

## Milestones

[Milestones](https://github.com/jdf2e/nutui-react/projects)

## Release Notes

NutUI follows [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153). The up-to-date release notes are available on [Release](https://github.com/jdf2e/nutui-react/releases)


## Open Source License

This project is based on **MIT** protocol