Ninja

This branch is for Webpack 2, for Webpack 1 support please checkout 0.x version in webpack1 branch.

Ninja powered front-end development server.

Check this blog post for more info about the development of Ninja.

Features

Generate routes automatically
Interpret Nodejs template
Jinja syntax supported(swig)
Livereload for HTML&CSS&JS
Proxy mode
Webpack compatible

Install

npm install -g ninja_cli

Configue using CLI

For example

ninja --template "swig" --webpack true --templateDir "/template"

Configue using file

Ninja will find ninja.conf.js under the working directory. ninja.conf.js is a CommonJS file like:

module.exports = {
	template: "swig", // whatever template engine you like
	mock: "/mock/mock.json", // dir for mock data
	webpack: true, // flag for using webpack or not
	proxy: {
		route: "/api",
		origin: "http://xueer.muxixyz.com"
	},
	staticDir: "/static",
	templateDir: "/template",
}

Options

  Usage: ninja [options]

  Options:

    -h, --help                 output usage information
    -p, --port [port]          Set the port of the server, defalut set to 3000
    -t, --template [item]      Set template engine, defalut set to swig
    -m, --mock [dir]           Set the source of mock data
    -w, --webpack [flag]       Serving static file using webpack or not, defalut set to false
    -o, --proxyOrigin [route]  Proxy origin configuration
    -r, --proxyRoute [url]     Proxy route configuration
    -s, --staticDir [dir]      Location of static file
    -d, --templateDir [dir]    Location of templates
    -b, --browser [item]       Set the defalut browser, defalut set to google chrome

Commands

ninja init <projectName> <template>

Examplle:

ninja init my-project webpack-vue

The above command pulls the template from slush-ninja-webpack-vue.

ninja start

Start Ninja dev server!

Templates

webpack-vue - A full-featured Webpack2 + Vue2

Examples

Take a look at the examples folder.

Change Log

v0.5 2017-5-1

refactor proxy for bypassing CORS.
all kinds of HTTP/HTTPS request are supported now.

v0.4 2016-10-30

add body-parser for express server, fix POST proxy body data missing case

v0.3 2016-10-28

add HTTP method setting for mock API

v0.2 2016-07-13

add example for webpack&gulp users
support CSS&Javascript livereload

v0.1 2016-07-02

initial commit

Super powered by Ninja

Xueer Mobile Web Version

Guisheng Mobile Web Version

FECademy

License

MIT 2017@MuxiStudio: check LICENSE file for detail.

Muxi-Studio/ninja