|
1 |
| -mango-cli [](https://travis-ci.org/manGoweb/mango-cli) [](https://www.npmjs.com/package/mango-cli) |
| 1 | +mango-cli-core |
2 | 2 | =========
|
3 | 3 |
|
4 |
| -[mangoweb.github.io/mango](http://mangoweb.github.io/mango) |
5 |
| - |
6 |
| -Scaffold and build your projects way more faster than before. Preconfigured frontend devstack to the absolute perfection. Fully automated to save your precious time. Ready for any type of web project. |
7 |
| - |
8 |
| -**A little example project** is here: [manGoweb/mango-cli-example](https://github.com/mangoweb/mango-cli-example). |
9 |
| - |
10 |
| -If you already have `mango-cli` you can init the example project simply by `mango init [your-directory]` |
11 |
| - |
12 |
| -## Under the hood |
13 |
| - |
14 |
| -<table> |
15 |
| -<tr><th colspan=2 align=left>Styles</th></tr> |
16 |
| -<tr><td><a href="http://learnboost.github.io/stylus">Stylus</a></td><td>expressive, robust, feature-rich CSS preprocessor</td></tr> |
17 |
| -<tr><td><a href="https://github.com/sass/libsass">Sass</a></td><td>CSS with superpowers</td></tr> |
18 |
| -<tr><td><a href="http://lesscss.org">Less</a></td><td>the dynamic stylesheet language</td></tr> |
19 |
| -<tr><td><a href="https://github.com/postcss/autoprefixer">Autoprefixer </a></td><td>vendor prefixes based on the real usage</td></tr> |
20 |
| -<tr><td><a href="https://github.com/jakubpawlowicz/clean-css">Clean-CSS</a></td><td>Fast and efficient CSS minifier</td></tr> |
21 |
| - |
22 |
| -<tr><th colspan=2 align=left>Templates</th></tr> |
23 |
| -<tr><td><a href="http://jade-lang.com">Jade</a></td><td>robust, elegant and feature rich template engine</td></tr> |
24 |
| - |
25 |
| -<tr><th colspan=2 align=left>Scripts</th></tr> |
26 |
| -<tr><td><a href="https://babeljs.io/">Babel</a></td><td>Use next generation JavaScript today</td></tr> |
27 |
| -<tr><td><a href="http://facebook.github.io/react">React</a></td><td>JavaScript library for building user interfaces from Facebook</td></tr> |
28 |
| -<tr><td><a href="http://coffeescript.org">CoffeeScript</a></td><td>little language that compiles into JavaScript</td></tr> |
29 |
| -<tr><td><a href="https://github.com/medikoo/modules-webmake">Webmake</a></td><td>JavaScript bundling with require() in the browser</td></tr> |
30 |
| -<tr><td><a href="http://lisperator.net/uglifyjs">UglifyJS</a></td><td>JavaScript minifier</td></tr> |
31 |
| - |
32 |
| -<tr><th colspan=2 align=left>Tools</th></tr> |
33 |
| -<tr><td><a href="http://www.browsersync.io">BrowserSync</a></td><td>Time-saving synchronised browser testing</td></tr> |
34 |
| -<tr><td><a href="https://www.npmjs.org">NPM</a></td><td>Node.js package manager</td></tr> |
35 |
| -<tr><td><a href="http://gulpjs.com/">Gulp</a></td><td>Automated build tasks</td></tr> |
36 |
| -<tr><td><a href="https://github.com/imagemin/imagemin">Imagemin</a></td><td>Seamless image minification</td></tr> |
37 |
| -<tr><td><a href="https://github.com/floridoo/gulp-sourcemaps">Sourcemaps</a></td><td>debug like a pro</td></tr> |
38 |
| -</table> |
| 4 | +Subset of the [mango-cli](http://mangoweb.github.io/mango) for a production use. |
39 | 5 |
|
40 | 6 | ## Installation
|
41 | 7 |
|
42 |
| -Install mango-cli once from `npm` and use it everywhere: |
43 |
| - |
44 | 8 | ```sh
|
45 |
| -npm install -g mango-cli |
| 9 | +npm install -g mango-cli-core |
46 | 10 | ```
|
47 | 11 |
|
48 | 12 | Just a few requirements you already have: [Node.js](http://nodejs.org) and [Git](http://git-scm.com) executable in `PATH` and if you are running __Windows__, there are even some more [special requirements because of node-gyp](https://github.com/TooTallNate/node-gyp).
|
49 | 13 |
|
50 |
| -## Usage |
51 |
| - |
52 |
| -* `mango init` - scaffolding and initialization |
53 |
| -* `mango install` - dependency installation |
54 |
| -* `mango build` - production build |
55 |
| -* `mango dev` - development mode |
56 |
| - |
57 |
| -Feel free to use `mango [command] -h` for detailed instructions |
58 |
| - |
59 |
| - |
60 |
| -### Project scaffolding and initialization |
61 |
| - |
62 |
| -```sh |
63 |
| -mango init [options] [directory] |
64 |
| -``` |
65 |
| - |
66 |
| -Forks a template into folder. |
67 |
| - |
68 |
| -Options: |
69 |
| -* `-s, --source [git_repository]` - git repository with a template to fork. Default is currently the [Frontbase](http://frontbase.org) |
70 |
| - |
71 |
| - |
72 |
| -### Managing project dependencies |
73 |
| - |
74 |
| -```sh |
75 |
| -mango install [packages...] |
76 |
| -``` |
77 |
| - |
78 |
| -Installs packages from NPM and stores them in `node_modules` folder, from where you can `require` them (thanks to browserify). |
79 |
| -Maintain current list in the `mango.json` config file under the `dependencies` section. |
80 |
| - |
81 |
| - |
82 |
| -### Project build |
83 |
| - |
84 |
| -Assuming the config file `mango.json` is present in a current directory and contains: |
85 |
| - |
86 |
| -```json |
87 |
| -{ |
88 |
| - "styles": [ |
89 |
| - "styles/screen.styl" |
90 |
| - ], |
91 |
| - "scripts": [ |
92 |
| - "scripts/index.js" |
93 |
| - ], |
94 |
| - "images": [ |
95 |
| - "images/**/*.{jpg,png,svg}" |
96 |
| - ], |
97 |
| - "templates": [ |
98 |
| - "templates/**/*.jade" |
99 |
| - ], |
100 |
| - "static": [ |
101 |
| - "fonts/**" |
102 |
| - ], |
103 |
| - "dependencies": [ |
104 |
| - "jquery" |
105 |
| - ], |
106 |
| - "watch": [ |
107 |
| - "app/**" |
108 |
| - ], |
109 |
| - "dist_folder": "dist" |
110 |
| -} |
111 |
| -``` |
112 |
| - |
113 |
| - |
114 |
| -#### Production build |
115 |
| - |
116 |
| -```sh |
117 |
| -mango build [tasks...] |
118 |
| -``` |
119 |
| - |
120 |
| -All assets are compiled and minified into `dist_folder`, ready for production use. |
121 |
| - |
122 |
| -Options: |
123 |
| -* `[tasks...]` - run only specified tasks as `styles`, `scripts`, `images`, `templates`, `static` |
124 |
| - |
125 |
| - |
126 |
| -#### Development mode |
127 |
| - |
128 |
| -```sh |
129 |
| -mango dev [http_proxy] |
130 |
| -``` |
131 |
| - |
132 |
| -Starts BrowserSync server (or proxy server) and watch for assets change. |
133 |
| - |
134 |
| - |
135 |
| -## Configuration |
| 14 | +## Command |
136 | 15 |
|
137 |
| -More in [Configuration options](docs/config.md) docs... |
| 16 | +* `mango-core install` - dependency installation |
| 17 | +* `mango-core build` - production build |
138 | 18 |
|
139 | 19 | ## Copyright
|
140 | 20 |
|
|
0 commit comments