https://github.com/mangoweb/mango-cli
A project scaffolding and build tool to accelerate your development
https://github.com/mangoweb/mango-cli
babel browsersync build-tool devstack frontend imagemin jade javascript less mango-cli pug react sass sourcemaps stylus typescript webpack workflow
Last synced: 2 months ago
JSON representation
A project scaffolding and build tool to accelerate your development
- Host: GitHub
- URL: https://github.com/mangoweb/mango-cli
- Owner: manGoweb
- License: mit
- Created: 2014-11-14T12:25:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T17:18:59.000Z (about 2 years ago)
- Last Synced: 2024-10-30T02:36:48.769Z (6 months ago)
- Topics: babel, browsersync, build-tool, devstack, frontend, imagemin, jade, javascript, less, mango-cli, pug, react, sass, sourcemaps, stylus, typescript, webpack, workflow
- Language: JavaScript
- Homepage: http://mangocli.org
- Size: 5.83 MB
- Stars: 30
- Watchers: 13
- Forks: 9
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
mango-cli [](https://circleci.com/gh/manGoweb/mango-cli/tree/master) [](https://www.npmjs.com/package/mango-cli) [](https://hub.docker.com/r/mangoweb/mango-cli/)
=========
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.
**A little example project** is here: [manGoweb/mango-cli-example](https://github.com/mangoweb/mango-cli-example).
- [Installation](#installation)
- [Requirements](#requirements)
- [Alternative methods](#alternative-methods)
- [Usage](#usage)
- [Project scaffolding and initialization](#project-scaffolding-and-initialization)
- [Managing project dependencies](#managing-project-dependencies)
- [Project build](#project-build)
- [Configuration](docs/config.md)
- [FAQ](https://github.com/manGoweb/mango-cli/wiki/FAQ)
## Under the hood
Styles
Stylusexpressive, robust, feature-rich CSS preprocessor
SassCSS with superpowers
Lessthe dynamic stylesheet language
Autoprefixer vendor prefixes based on the real usage
Clean-CSSFast and efficient CSS minifier
Templates
Pug (Jade)robust, elegant and feature rich template engine
Scripts
WebpackStatic module bundler for modern JavaScript applications
TypeScriptTyped superset of JavaScript
BabelUse next generation JavaScript today
ReactJavaScript library for building user interfaces from Facebook
SvelteCybernetically enhanced web apps
UglifyJSJavaScript minifier
Tools
BrowserSyncTime-saving synchronised browser testing
NPMNode.js package manager
GulpAutomated build tasks
ImageminSeamless image minification
Sourcemapsdebug like a pro
## Installation
Install mango-cli once from `npm` and use it everywhere:
```sh
npm install -g mango-cli
```
### Requirements
Before installation check that your system has these requirements:
- [Node.js LTS (10.x)](https://nodejs.org/en/download/)
- [Git](http://git-scm.com) executable in `PATH`
#### Mac OS X
* `python` (`v2.7` recommended, `v3.x.x` is __*not*__ supported) (already installed on Mac)
* [Xcode](https://developer.apple.com/xcode/download/)
* You also need to install the `Command Line Tools` via Xcode. You can find this under the menu `Xcode -> Preferences -> Downloads`
* [libvips](https://jcupitt.github.io/libvips/) via Homebrew `brew install vips`
#### Windows
* [windows-build-tools](https://github.com/felixrieseberg/windows-build-tools) via `npm install -g --production windows-build-tools` (from an elevated PowerShell)
* will install and configure *Python v2.7* and *Visual C++ Build Tools 2015* for you
#### Linux
* `python` (`v2.7` recommended, `v3.x.x` is __*not*__ supported)
* `make`
* A proper C/C++ compiler toolchain, like [GCC](https://gcc.gnu.org)
### Alternative methods
#### Docker
We also provide a Docker image `mangoweb/mango-cli` which is available on the [Docker HUB](https://hub.docker.com/r/mangoweb/mango-cli/)
#### Pre-packed archives
If you're still having problems with the installation, check out prepared [release packages](https://github.com/manGoweb/mango-cli/releases).
Extract them locally and run `npm link` in the `mango-cli` folder (on Mac OS X you still need the `libvips` dependency though).
## Usage
* `mango init` - scaffolding and initialization
* `mango install` - dependency installation
* `mango build` - production build
* `mango dev` - development mode
Feel free to use `mango [command] -h` for detailed instructions
### Project scaffolding and initialization
```sh
mango init [options] [directory]
```
Forks a template into folder.
Options:
* `-s, --source [git_repository]` - git repository with a template to fork. Default is currently the [mango-cli-example](https://github.com/manGoweb/mango-cli-example)
### Managing project dependencies
```sh
mango install [packages...]
```
Installs packages from NPM and stores them in `node_modules` folder, from where you can `require` them (thanks to browserify).
Maintain current list in the `mango.yaml` config file under the `dependencies` section.
### Project build
Assuming the config file `mango.yaml` is present in a current directory and contains:
```yaml
styles:
- styles/screen.styl
scripts:
- scripts/index.js
images:
- images/**/*.{jpg,png,svg}
templates:
- templates/**/*.pug
static:
- fonts/**
dependencies:
- jquery
watch:
- app/**
dist_folder: dist
```
Config file can be in JSON or JS formats. `mango.json` gets parsed as a JSON file, `mango.config.js` gets required as-is.
#### Production build
```sh
mango build [tasks...]
```
All assets are compiled and minified into `dist_folder`, ready for production use.
Options:
* `[tasks...]` - run only specified tasks as `styles`, `scripts`, `images`, `templates`, `static`
#### Development mode
```sh
mango dev [http_proxy]
```
Starts BrowserSync server (or proxy server) and fs watch for assets change.
## Configuration
More in [Configuration options](docs/config.md) docs...
## FAQ
More in [the Wiki page...](https://github.com/manGoweb/mango-cli/wiki/FAQ)
## Copyright
Copyright 2016-2018 [manGoweb s.r.o.](https://www.mangoweb.cz) Code released under [the MIT license](LICENSE). Evolved from [Frontbase](http://frontbase.org) devstack.