3.0.9 • Published 9 years ago

apeman-ui v3.0.9

Weekly downloads
4
License
MIT
Repository
github
Last release
9 years ago

apeman-ui

Build Status Code Climate Code Coverage npm Version JS Standard

UI server for apeman

Installation

Install apeman-ui module via npm.

$ npm install apeman-ui -g

Usage

  1. Prepare an Apemanfile.js at your project root.
  2. Run the command via CLI.

Apemanfile.js

/** Example of Apemanfile.js */

'use strict'

module.exports = {
  $cwd: __dirname,
  $pkg: { /* ... */ },
  $proto: [ /* ... */ ],
  $ui: {
    'user': {
      profile () {
        return Promise.resolve(`
<html><!-- ... ---></html>
`)
      }
    }
  }
}

Then,

$ apeman-ui
CLI Options
$ apeman-ui -h

  Usage: apeman-ui [options] 

  UI server for apeman

  Options:

    -h, --help                           output usage information
    -V, --version                        output the version number
    -v, --verbose                        Show verbose logs
    -c, --configuration <configuration>  Pathname of Apemanfile

  Examples:

  $ apeman-ui                   # __description_of_command_usage__

Programmatic API

apeman-ui also provide programmatic API.

Firstly, install the module locally.

$ npm install apeman-ui --save-dev

Then,

#!/usr/bin/env

'use strict'

const apemanUi = require('apeman-ui')
const co = require('co')

co(function * () {
  yield apemanUi({})
}).catch((err) => console.error(err))
Programmatic Options
KeyDescriptionDefault
portPort number to invoke
configurationPathname of Apemanfile

License

This software is released under the MIT License.

Links

3.0.9

9 years ago

3.0.8

9 years ago

3.0.7

9 years ago

3.0.6

9 years ago

3.0.5

9 years ago

3.0.4

9 years ago

3.0.3

9 years ago

3.0.2

9 years ago

3.0.0

9 years ago

2.0.6

9 years ago

2.0.4

10 years ago

2.0.3

10 years ago

2.0.2

10 years ago

2.0.1

10 years ago

2.0.0

10 years ago

1.1.1

10 years ago

1.1.0

10 years ago

1.0.1

10 years ago

1.0.0

10 years ago