Mod is a task-based workflow tooling for web, it help developers quickly build robust and high-performance HTML5 applications.

Installation

Mod is installed using NPM(Node Package Manager)

$ npm install modjs -g

Why another one?

• Focus on the workflow of web development
• Much built-in tasks, most pleasant out-of-the-box experience
• More simplicity plugin mechanism, auto-install plugins
• Configuration less(even zero), do more
• Built-in web server with very useful feature like remote logging for mobile development
• Compatible with Grunt plugins

Tutorials

• Getting Started
• Configuring Tasks
• Creating Plugins

Documents

• Built-in Task
• Plugin API

Quick Build Demo

• Plain Project Build
• Mobile Project Build
• RequireJS Project Build
• SeaJS Project Build

IDE Support

• Sublime-Mod

Built-in Task Examples

• Concatenate JS Files
• Concatenate CSS Files
• AMD Modules Compile
• CMD Modules Compile
• Mutil-page Modules Compile
• CSS Precompile
• HTML Precompile
• JPG Image Compression
• PNG Image Compression
• JS Minify
• CSS Minify
• HTML Minify
• Code Stripping
• EOL Stripping
• Tab Stripping
• Inline Images DataURI
• Make Dir
• Copy Files

Plugins Examples

• NPM Task: mod-stylus
• Local Task: mytask.js
• Grunt Task: grunt-contrib-concat

Built-in Web Server Examples

• Server with remote logging for mobile development
• Server with proxy setting

Features

• Build with main html
• Task-based workflow
• Source minify: JS, CSS, HTML
• Modular JS Compile: AMD, CMD (will support ES6 Module, CommonJS Module soon)
• CSS @import file combination
• Source stripping, automatically remove debugging code
• Basic operation: cat, rm, mv, mkdir, cp, rev
• File watcher, trigger custom tasks when file change
• Live Browser Reloads, instantly see changes in your browser
• Image Optimization, reduce JPEG, PNG file sizes
• Project boilerplate generate
• Built-in Web Server: mod server
• Extensible, easily write plugins

Preview

Platform Support

Mod support Windows, OS X, Linux...

Issue Submission

Submit a new issue.

About

Mod is an open-source project by Tencent which builds on top of Node.js. We utilize a number of useful open-source solutions including:

• UglifyJS
• CleanCSS
• HTMLMinifiler
• RequireJS
• SeaJS
• OptiPNG
• JPEGtran
• JSConsole

Used by people within (JOIN US)

License

Mod is released under a MIT license.