Apeman-proto-adminapi NPM

apeman-proto-adminapi

Prototype for admin api projects.

Installation

$ npm install apeman-proto-adminapi --save

Usage

/** This is an example Apemanfile.js */

'use strict'

module.exports = {
    $ctx: {
        // Project context
    },
    $pkg: {/* ... */},
    $proto: [
        // Inherit apeman-proto-adminapi project.
        require('apeman-proto-adminapi')
    ],
    $tmpls: {/* ... */},
    $tasks: {/* ... */}
}

Apemanfile Configurations

$pkg

Name	Value
name	apeman-proto-adminapi
version	3.0.2
description	Prototype for admin api projects.

$proto

$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/.middleware.js.bud	false	'644'	`#!/usr/bin/env node /** * Bud file ...`	{"year":2016,"params":{"type":"apiMid...
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/.route.js.bud	false	'644'	`#!/usr/bin/env node /** * Bud file ...`	{"year":2016,"params":{"type":"adminA...
routes/index.js	false	'644'	`/** * Exports route modules. * * G...`	{"params":{},"generator":"apeman-tmpl...
schemas/.schema.js.bud	false	'644'	`#!/usr/bin/env node /** * Bud file ...`	{"year":2016,"params":{"type":"schema...
schemas/index.js	false	'644'	`/** * Exports schema settings{{#if n...`	{"params":{},"generator":"apeman-tmpl...
settings/.setting.json.bud	false	'644'	`#!/usr/bin/env node /** * Bud file ...`	{"year":2016,"params":{"type":"settin...
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-...

$apps

Name	Description
adminapi:dynamic	Serve dynamic content
adminapi:static	Serve static files
api:dynamic	Serve dynamic content
api:middleware	{"/":[]}
api:static	Serve static files
dynamic:body	{}
dynamic:delay	Add delay.
dynamic:env	Set env header to response.
dynamic:log	Log requests.
dynamic:middleware	{"/":[]}
public:static	Serve static files.
session:enable	Enable session feature.
session:flush	Add flush message support with session

$tasks

Name	Description
adminapi:mkdir	Generate directories for API app.
adminapi:render	Render bud files.
api:mkdir	Generate directories for API app.
api:render	Render bud files.
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.

$wtchs

Name	Description
api:render	{"pattern":"+(schemas)/*/..bud"}
app:render	{"pattern":"+(errors	constants	public	routes	tests	settings)/*/..bud"}
test:render	{"pattern":"test/*/..bud"}