| 1 | Sero-cli
|
| 2 | =========
|
| 3 |
|
| 4 | [![NPM version][npm-image]][npm-url]
|
| 5 | ![][david-url]
|
| 6 | ![][travis-url]
|
| 7 |
|
| 8 | > The web application development toolkit
|
| 9 |
|
| 10 |
|
| 11 | 
|
| 12 |
|
| 13 | Sero-cli provides a friendly interactive interface to help developers start developing web application on `Github`. All you need to do is pressing [KEY_UP]/[KEY_DOWN] to navigate the specific task you'd like to execute.
|
| 14 |
|
| 15 | ## Background knowledge ##
|
| 16 | Following technologies are recommended to know before starting use it.
|
| 17 |
|
| 18 | > [Nodejs](http://www.nodejs.org/) is a platform built on Chrome's JavaScript runtime for easily building fast, scalable network applications<br/>
|
| 19 | > [NPM](http://www.npmjs.org/) is the official package manager for `Node.js`<br/>
|
| 20 | > [bower](http://bower.io/) works by fetching and installing packages from all over, taking care of hunting, finding, downloading, and saving the stuff you’re looking for<br/>
|
| 21 |
|
| 22 | ## Installation ##
|
| 23 |
|
| 24 | ```shell
|
| 25 | npm install sero-cli -g
|
| 26 | ```
|
| 27 |
|
| 28 | ## Basic Usage ##
|
| 29 |
|
| 30 | Move to whatever the location you want to work in.
|
| 31 |
|
| 32 | ```shell
|
| 33 | sero
|
| 34 | ```
|
| 35 |
|
| 36 | ## Advanced Usage ##
|
| 37 |
|
| 38 | Advanced user may love specifying the task directly without choosing them from UI. We provide the command line to achieve this.
|
| 39 |
|
| 40 |
|
| 41 | ```shell
|
| 42 | sero [command] [options]
|
| 43 | ```
|
| 44 |
|
| 45 | For example:
|
| 46 |
|
| 47 | ```shell
|
| 48 | sero git -u testuser -e test@gmail.com
|
| 49 | ```
|
| 50 |
|
| 51 | > Above command is equivalent to `Configure git options for current working directory`
|
| 52 |
|
| 53 | User `sero --help` to check the usage for each task
|
| 54 |
|
| 55 | ## Available Tasks ##
|
| 56 |
|
| 57 | - [Configure git options for current working directory](./docs/task_gitconf.md)
|
| 58 | - [Start a static web server for current working directory](./docs/task_startwebserver.md)
|
| 59 | - [Create a brand new repository on Github](./docs/task_createrepo.md)
|
| 60 | - [Launch web service simulator](./docs/task_startwebservicesimulator.md)
|
| 61 | - [Build Javascripts into one 'main.js'](./docs/build.md)
|
| 62 |
|
| 63 | ## LICENSE ##
|
| 64 |
|
| 65 | [MIT License](http://en.wikipedia.org/wiki/MIT_License)
|
| 66 |
|
| 67 | [npm-url]: https://npmjs.org/package/sero-cli
|
| 68 | [npm-image]: https://badge.fury.io/js/sero-cli.png
|
| 69 | [david-url]: https://david-dm.org/leftstick/sero-cli.png
|
| 70 | [travis-url]: https://api.travis-ci.org/leftstick/Sero-cli.svg?branch=master |
| \ | No newline at end of file |