apeman-proto-app

apeman-proto-app ==========   <a name="badges"></a> [![Build Status][bd_travis_shield_url]][bd_travis_url] [![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url] [![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_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-proto-labo/apeman-proto-app [bd_travis_url]: http://travis-ci.org/apeman-proto-labo/apeman-proto-app [bd_travis_shield_url]: http://img.shields.io/travis/apeman-proto-labo/apeman-proto-app.svg?style=flat [bd_travis_com_url]: http://travis-ci.com/apeman-proto-labo/apeman-proto-app [bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-proto-labo/apeman-proto-app.svg?token= [bd_license_url]: https://github.com/apeman-proto-labo/apeman-proto-app/blob/master/LICENSE [bd_codeclimate_url]: http://codeclimate.com/github/apeman-proto-labo/apeman-proto-app [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-proto-labo/apeman-proto-app.svg?style=flat [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-proto-labo/apeman-proto-app.svg?style=flat [bd_gemnasium_url]: https://gemnasium.com/apeman-proto-labo/apeman-proto-app [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-proto-labo/apeman-proto-app.svg [bd_npm_url]: http://www.npmjs.org/package/apeman-proto-app [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-proto-app.svg?style=flat [bd_standard_url]: http://standardjs.com/ [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg   <a name="description"></a> Prototype for app project.   <a name="overview"></a>   <a name="sections"></a>  <a name="section-doc-guides-01-installation-md"></a> Installation ----- ```bash $ npm install apeman-proto-app --save ```   <a name="section-doc-guides-02-usage-md"></a> Usage --------- ```javascript 'use strict' module.exports = { $pkg: { /* ... */ }, $proto: [ // Inherit apeman-proto-app project. require('apeman-proto-app') ], $tmpls: { /* ... */ }, $tasks: { /* ... */ } } ```   <a name="section-doc-guides-03-apemanfile-md"></a> ## Apemanfile Configurations + [$pkg](#apdoc-pkg) + [$proto](#apdoc-proto) + [$tmpls](#apdoc-tmpls) + [$tasks](#apdoc-tasks) + [$wtchs](#apdoc-wtchs) + [$needs](#apdoc-needs) <a name="apdoc-pkg"></a> ### $pkg | Name | Value | | --- | ---- | | name | apeman-proto-app | | version | 3.0.3 | | description | Prototype for app project. | <a name="apdoc-proto"></a> ### $proto + [apeman-proto-mocha](https://github.com/apeman-proto-labo/apeman-proto-mocha#readme) + [apeman-proto-wtch](https://github.com/apeman-proto-labo/apeman-proto-wtch#readme) + [apeman-proto-abstract](https://github.com/apeman-proto-labo/apeman-proto-abstract#readme) <a name="apdoc-tmpls"></a> ### $tmpls | Path | Force | Mode | Tmpl | Data | | ---- | ---- | ---- | --- | --- | | **constants/.constants.js.bud** | false | '644' | `#!/usr/bin/env node /** * Bud file ...` | {"year":2016,"params":{"type":"consts... | | **constants/index.js** | false | '644' | `/** * Exports constants modules. * ...` | {"params":{},"generator":"apeman-tmpl... | | **errors/.html.bud** | false | '644' | `/** * Bud file for error * Executin...` | {"year":2016,"params":{"type":"error"... | | **middlewares/index.js** | false | '644' | `/** * Exports middleware modules. *...` | {"params":{},"generator":"apeman-tmpl... | | **public/humans.txt** | false | '644' | `{{! apeman-tmpl-humans }} /* TEAM */ ...` | {"params":{},"generator":"apeman-tmpl... | | **public/robots.txt** | false | '644' | `{{! apeman-tmpl-robot }}# robot.txt #...` | {"params":{"disallow":["errors","tmp"... | | **routes/index.js** | false | '644' | `/** * Exports route modules. * * G...` | {"params":{},"generator":"apeman-tmpl... | | **settings/index.js** | false | '644' | `/** * Project settings. * * Genera...` | {"params":{},"generator":"apeman-tmpl... | | **tests/.test.js.bud** | false | '644' | `#!/usr/bin/env node /** * Bud file ...` | {"year":2016,"params":{"type":"route-... | <a name="apdoc-tasks"></a> ### $tasks | Name | Description | | ---- | --- | | **app:fmt** | Format a json file. | | **app:mkdir** | Generate directories for app. | | **app:render** | Render bud files. | | **app:test** | ["mocha:run"] | | **mocha:mkdir** | Generate directories for project with mocha. | | **mocha:render** | Render files for project with mocha. | | **mocha:run** | Run mocha tests. | | **test:mkdir** | Generate directories. | | **test:render** | Render coz bud files. | | **wtch:list** | List available watches. | | **wtch:start** | Start all watches. | <a name="apdoc-wtchs"></a> ### $wtchs | Name | Description | | ---- | --- | | **app:render** | {"pattern":"+(errors|constants|public|routes|tests|settings)/**/.*.bud"} | | **test:render** | {"pattern":["tests/**/.*.bud"]} | <a name="apdoc-needs"></a> ### $needs | Bin | How to install | | --- | ----- | | **apeman** | `npm install -g apeman` | | **mocha** | `npm install -g mocha` |    <a name="license"></a> License ------- This software is released under the [MIT License](https://github.com/apeman-proto-labo/apeman-proto-app/blob/master/LICENSE).   <a name="links"></a> Links ------ + [apeman](http://github.com/apeman-labo/apeman) + [apeman-proto](https://github.com/apeman-cmd-labo/apeman-proto)