meido

Install

$ npm install -g meido

Usage

# serve current working directory
$ meido

# serve elsewhere
$ meido ./public

# serve and open the webpage
$ meido --open

# serve in different port
$ meido --port 4000

# help
$ meido --help

What does meido stand for?

Obviously, meido is the prononciation of メイド in Japanese, which means maid in English.

How is it different from tj/serve?

As how meido describes herself, more straight-forward and friendly.

API

import meido from 'meido'

meido(options, callback)

options

port

Type: number
Default: 3000

dir

Type: string
Default: ./

The directory to serve.

open

CLI only

Type: boolean
Default: false

Open the webpage in browser after the server is established.

callback

Type: function
Args: app - Express server instance

Run the callback function after the server is established. You can get the server port by app.get('port')

License

MIT © EGOIST