README.md 2.42 KB
Newer Older
super-lin0's avatar
docs  
super-lin0 committed
1
# create-nemean
super-lin0's avatar
super-lin0 committed
2 3 4

Creates a UmiJS application/plugin/block/library using the command line.

super-lin0's avatar
docs  
super-lin0 committed
5
[![NPM version](https://img.shields.io/npm/v/create-umi.svg?style=flat)](https://www.npmjs.com/package/create-nemean) [![NPM downloads](http://img.shields.io/npm/dm/create-umi.svg?style=flat)](https://www.npmjs.com/package/create-nemean)
super-lin0's avatar
super-lin0 committed
6 7 8 9

## Usage

```bash
super-lin0's avatar
docs  
super-lin0 committed
10
$ yarn create nemean [appName]
super-lin0's avatar
super-lin0 committed
11 12 13 14
```

## Boilerplates

super-lin0's avatar
docs  
super-lin0 committed
15 16 17 18 19
- `ant-design-pro` - Create project with a layout-only ant-design-pro boilerplate, use together with umi block.
- `app` - Create project with a simple boilerplate, support typescript.
- `block` - Create a umi block.
- `library` - Create a library with umi.
- `plugin` - Create a umi plugin.
super-lin0's avatar
super-lin0 committed
20 21 22 23

## Usage Example

```bash
super-lin0's avatar
docs  
super-lin0 committed
24
$ yarn create nemean
super-lin0's avatar
super-lin0 committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

? Select the boilerplate type (Use arrow keys)
  ant-design-pro  - Create project with a layout-only ant-design-pro boilerplate, use together with umi block.
❯ app             - Create project with a simple boilerplate, support typescript.
  block           - Create a umi block.
  library         - Create a library with umi.
  plugin          - Create a umi plugin.

? Do you want to use typescript? (y/N)

? What functionality do you want to enable? (Press <space> to select, <a> to toggle all, <i> to invert selection)
❯◯ antd
 ◯ dva
 ◯ code splitting
 ◯ dll

  create abc/package.json
  create abc/.gitignore
  create abc/.editorconfig
  create abc/.env
  create abc/.eslintrc
  create abc/.prettierignore
  create abc/.prettierrc
  create abc/.umirc.js
  create abc/mock/.gitkeep
  create abc/src/assets/yay.jpg
  create abc/src/global.css
  create abc/src/layouts/index.css
  create abc/src/layouts/index.tsx
  create abc/src/pages/index.css
  create abc/src/pages/index.tsx
  create abc/tsconfig.json
  create abc/typings.d.ts
 📋  Copied to clipboard, just use Ctrl+V
 ✨  File Generate Done
```

## FAQ

super-lin0's avatar
docs  
super-lin0 committed
64
### `yarn create nemean` command failed
super-lin0's avatar
super-lin0 committed
65 66 67 68 69 70 71 72 73 74 75 76 77

这个问题基本上都是因为没有添加 yarn global module 的路径到 PATH 环境变量引起的。

先执行 `yarn global bin` 拿到路径,然后添加到 PATH 环境变量里。

```bash
$ yarn global bin
/usr/local/bin
```

你也可以尝试用 npm,

```bash
super-lin0's avatar
docs  
super-lin0 committed
78
$ npm create nemean appName
super-lin0's avatar
super-lin0 committed
79 80
```

super-lin0's avatar
docs  
super-lin0 committed
81
或者手动安装 create-nemean,并执行他,
super-lin0's avatar
super-lin0 committed
82 83

```bash
super-lin0's avatar
docs  
super-lin0 committed
84 85
$ npm install create-nemean -g
$ create-nemean
super-lin0's avatar
super-lin0 committed
86 87 88 89
```

## Questions & Suggestions

super-lin0's avatar
docs  
super-lin0 committed
90
Please open an issue [here](http://platform.kuopu.net:9999/gitlab/nemean-group/nemean-pro/issues).
super-lin0's avatar
super-lin0 committed
91 92 93 94

## LICENSE

MIT