apeman-scff
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/apeman-cmd-labo/apeman-scff
[bd_travis_url]: http://travis-ci.org/apeman-cmd-labo/apeman-scff
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-cmd-labo/apeman-scff.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-cmd-labo/apeman-scff
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-cmd-labo/apeman-scff.svg?token=
[bd_license_url]: https://github.com/apeman-cmd-labo/apeman-scff/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-cmd-labo/apeman-scff
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-cmd-labo/apeman-scff.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-cmd-labo/apeman-scff.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-cmd-labo/apeman-scff
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-cmd-labo/apeman-scff.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-scff
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-scff.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Project scaffolding tool.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>

Overview
--------

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

 There are [official scaffold plugins][scaffold_labo_url] supported by apeman team.
 
 [scaffold_labo_url]: https://github.com/apeman-scaffold-labo

<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install apeman-scff -g
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------


```bash
$ apeman-scaffold web my-awesome-project
```


#### CLI Options

```bash
$ 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


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Programmatic API.md.hbs" Start -->

<a name="section-doc-guides-03-programmatic-a-p-i-md"></a>

Programmatic API
---

apeman-scff also provide programmatic API.

Firstly, install the module locally.

```bash
$ npm install apeman-scff --save-dev
```

Then,

```javascript
'use strict'

const apemanScaffold = require('apeman-scaffold')

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

```


#### Programmatic Options

| Key | Description | Default |
| --- | ----------- | ------- |
| straight | Scaffold without asking. |  |
| silent | Disable console logs |  |
| force | Force to generate scaffold |  |


<!-- Section from "doc/guides/03.Programmatic API.md.hbs" End -->

<!-- Section from "doc/guides/04.Contributing.md.hbs" Start -->

<a name="section-doc-guides-04-contributing-md"></a>

Contribution
------
You can create your own task plugin quickly with scaffold.
Install [apeman-scaffold][scaffold_url] as a global module
```bash
$ npm install apeman-scaffold -g
```
then, generate scaffold.
```bash
$ apeman-scaffold scaffold apeman-scaffold-yourown
```
[scaffold_url]: https://www.npmjs.com/package/apeman-scaffold

<!-- Section from "doc/guides/04.Contributing.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/apeman-cmd-labo/apeman-scff/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [apeman][apeman_url]
+ [apeman-cmd-labo][apeman_cmd_labo_url]
+ [apeman-scff-labo][apeman_scff_labo_url]

[apeman_url]: https://github.com/apeman-labo/apeman
[apeman_cmd_labo_url]: http://github.com/apeman-cmd-labo
[apeman_scff_labo_url]: https://github.com/apeman-scff-labo

<!-- Links End -->