| 1 | <img src="http://tinper.org/assets/images/uba.png" width="120" />
|
| 2 |
|
| 3 | # tinper-uba
|
| 4 |
|
| 5 |
|
| 6 |
|
| 7 | [](https://www.npmjs.com/package/uba)
|
| 8 | [](https://travis-ci.org/iuap-design/tinper-uba)
|
| 9 | [](https://david-dm.org/iuap-design/tinper-uba#info=devDependencies)
|
| 10 | [](https://npmjs.org/package/uba)
|
| 11 |
|
| 12 | [中文文档](https://github.com/iuap-design/tinper-uba/blob/master/README_zh-CN.md)
|
| 13 |
|
| 14 | ## Introduction
|
| 15 | `uba` is a front-end development tool which can provide multipul boilerplates. Developers can update and do maintenance with [uba-templates](https://github.com/uba-templates), and of course different templates are provided according to the styles and functions which are needed.
|
| 16 |
|
| 17 | ## Features
|
| 18 | `uba` can remote access to [uba-templates](https://github.com/uba-templates) to get the boilerplates, and to choose the boilerplate that needed through HCI. It can guide the users to use uba step by step. And what is more exciting, uba can make the manual commands automatically.
|
| 19 |
|
| 20 |
|
| 21 | ### Installation
|
| 22 | 1. Install [node.js](http://nodejs.org/) development environment.(node > 6.x && npm > 2.x)
|
| 23 | 2. `npm install uba -g` Global installation.
|
| 24 | 3. Install complete input `uba -v` The output version number indicates that the installation is successful.
|
| 25 | 4. View help and Plugins `uba -h`or`uba -h`.
|
| 26 |
|
| 27 |
|
| 28 | ### Usage
|
| 29 |
|
| 30 |
|
| 31 | ```sh
|
| 32 | $ uba init
|
| 33 | ```
|
| 34 | 1. Open terminal,input `uba` view.
|
| 35 | 2. `uba init` Displays the boilerplate names and descriptions available online.
|
| 36 | 3. Keyboard select what you need boilerplate.( `↑` , `↓` )
|
| 37 | 4. Follow the steps next to the operation
|
| 38 |
|
| 39 | ## Quick start
|
| 40 |
|
| 41 | 1. `npm install uba -g`.
|
| 42 |
|
| 43 | 2. `uba init` select `template-react-multiple-pages` enter, input name `uba-react`.
|
| 44 |
|
| 45 | 3. Wait a moment.Indicates whether the npm package is installed automatically, `y`.
|
| 46 |
|
| 47 | 4. Enter `cd uba-react` && `uba server` or `npm run dev`,start a develop server, automatically opens the default browser.
|
| 48 |
|
| 49 | 5. Try to build a package for our project. enter `uba build`,Wait a minute is success.
|
| 50 |
|
| 51 | 6. 😆 It is convenient to enjoy uba for pleasure!
|
| 52 |
|
| 53 | ## show
|
| 54 |
|
| 55 | ### uba or uba -h
|
| 56 | <img width="476" alt="uba" src="https://user-images.githubusercontent.com/12147318/27854369-27241b56-6199-11e7-9176-95609a7069a8.png">
|
| 57 |
|
| 58 | ### uba init
|
| 59 | 
|
| 60 |
|
| 61 | ### uba server
|
| 62 | 
|
| 63 |
|
| 64 | ### uba build
|
| 65 | 
|
| 66 |
|
| 67 |
|
| 68 | ## API
|
| 69 |
|
| 70 | ### Version
|
| 71 | ```sh
|
| 72 | $ uba -v
|
| 73 | ```
|
| 74 |
|
| 75 | ### Help
|
| 76 | ```sh
|
| 77 | $ uba -h
|
| 78 | ```
|
| 79 |
|
| 80 | ### Template
|
| 81 | ```sh
|
| 82 | $ uba init
|
| 83 | ```
|
| 84 |
|
| 85 | ### DevServer
|
| 86 | ```sh
|
| 87 | $ uba server
|
| 88 | ```
|
| 89 |
|
| 90 | ### Build
|
| 91 | ```sh
|
| 92 | $ uba build
|
| 93 | ```
|
| 94 |
|
| 95 | ### Make Plugin
|
| 96 | ```sh
|
| 97 | $ uba plugin <name>
|
| 98 | ```
|
| 99 | ### Install Plugin
|
| 100 | ```sh
|
| 101 | $ uba install init
|
| 102 | ```
|
| 103 |
|
| 104 |
|
| 105 | ## Advanced section
|
| 106 |
|
| 107 | to be continued...
|
| 108 |
|
| 109 | ## Contribution
|
| 110 | Please make sure to read the Contributing Guide before making a pull request.
|
| 111 |
|
| 112 | ## Licence
|
| 113 | [MIT](https://github.com/iuap-design/tinper-uba/blob/master/LICENSE)
|