apeman-scff

Project scaffolding tool.

Overview

apeman-scff helps you to generate an apeman project structure for quick start.

There are official scaffold plugins supported by apeman team.

Installation

$ npm install apeman-scff -g

Usage

$ apeman-scaffold web my-awesome-project

CLI Options

$ apeman-scff -h
 
  Usage: apeman-scff [options] [type] [dest] 
 
  Generate project scaffold.
 
  Options:
 
    -h, --help      output usage information
    -V, --version   output the version number
    -t, --straight  Scaffold without asking.
    -s, --silent    Disable console logs
    -f, --force     Force to generate scaffold
 
 

Available Types

• api
• asset
• cmd
• demo
• db
• mock
• middleware
• lib
• loc
• react
• scff
• service
• web

Programmatic API

apeman-scff also provide programmatic API.

Firstly, install the module locally.

$ npm install apeman-scff --save-dev

Then,

'use strict'
 
const apemanScaffold = require('apeman-scaffold')
 
// Generate a project with "plain" template.
apemanScaffold('plain', '~/project/my-awesome-project', {}).then(() => {
  /* ... */
})
 

Programmatic Options

Contribution

You can create your own task plugin quickly with scaffold. Install apeman-scaffold as a global module

$ npm install apeman-scaffold -g

then, generate scaffold.

$ apeman-scaffold scaffold apeman-scaffold-yourown

License

This software is released under the MIT License.

Links

• apeman
• apeman-cmd-labo
• apeman-scff-labo