1 | apeman-app-dynamic
|
2 | ==========
|
3 |
|
4 |
|
5 | This file is generated by ape-tmpl. Do not update manually.
|
6 | --->
|
7 |
|
8 |
|
9 | <a name="badges"></a>
|
10 |
|
11 | [![Build Status][bd_travis_shield_url]][bd_travis_url]
|
12 | [![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
|
13 | [![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
|
14 | [![npm Version][bd_npm_shield_url]][bd_npm_url]
|
15 |
|
16 | [bd_repo_url]: https://github.com/apeman-app-labo/apeman-app-dynamic
|
17 | [bd_travis_url]: http://travis-ci.org/apeman-app-labo/apeman-app-dynamic
|
18 | [bd_travis_shield_url]: http://img.shields.io/travis/apeman-app-labo/apeman-app-dynamic.svg?style=flat
|
19 | [bd_license_url]: https://github.com/apeman-app-labo/apeman-app-dynamic/blob/master/LICENSE
|
20 | [bd_codeclimate_url]: http://codeclimate.com/github/apeman-app-labo/apeman-app-dynamic
|
21 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-app-labo/apeman-app-dynamic.svg?style=flat
|
22 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-app-labo/apeman-app-dynamic.svg?style=flat
|
23 | [bd_gemnasium_url]: https://gemnasium.com/apeman-app-labo/apeman-app-dynamic
|
24 | [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-app-labo/apeman-app-dynamic.svg
|
25 | [bd_npm_url]: http://www.npmjs.org/package/apeman-app-dynamic
|
26 | [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-app-dynamic.svg?style=flat
|
27 | [bd_bower_badge_url]: https://img.shields.io/bower/v/apeman-app-dynamic.svg?style=flat
|
28 |
|
29 |
|
30 |
|
31 |
|
32 |
|
33 | <a name="description"></a>
|
34 |
|
35 | apeman app to serve dynamic contents.
|
36 |
|
37 |
|
38 |
|
39 |
|
40 |
|
41 | <a name="overview"></a>
|
42 |
|
43 |
|
44 | Overview
|
45 | -------
|
46 |
|
47 | This app is an combination of these apeman apps.
|
48 |
|
49 | + [apeman-app-form](https://github.com/apeman-app-labo/apeman-app-form#readme)
|
50 | + [apeman-app-query](https://github.com/apeman-app-labo/apeman-app-query#readme)
|
51 | + [apeman-app-header](https://github.com/apeman-app-labo/apeman-app-header#readme)
|
52 | + [apeman-app-lang](https://github.com/apeman-app-labo/apeman-app-lang#readme)
|
53 | + [apeman-app-location](https://github.com/apeman-app-labo/apeman-app-location#readme)
|
54 | + [apeman-app-redirect](https://github.com/apeman-app-labo/apeman-app-redirect#readme)
|
55 | + [apeman-app-json](https://github.com/apeman-app-labo/apeman-app-json#readme)
|
56 | + [apeman-app-html](https://github.com/apeman-app-labo/apeman-app-html#readme)
|
57 |
|
58 | Theses apeman apps provide basic access for req/res like `req.body`, `req.query`, `res.json`, etc.
|
59 |
|
60 |
|
61 |
|
62 |
|
63 |
|
64 |
|
65 | <a name="sections"></a>
|
66 |
|
67 |
|
68 |
|
69 | <a name="section-doc-readme-01-installation-md"></a>
|
70 | Installation
|
71 | -----
|
72 |
|
73 | ```bash
|
74 | $ npm install apeman-app-dynamic --save
|
75 | ```
|
76 |
|
77 |
|
78 |
|
79 |
|
80 |
|
81 |
|
82 | <a name="section-doc-readme-02-usage-md"></a>
|
83 | Usage
|
84 | ---------
|
85 |
|
86 | 1. Define an app within Apemanfile.js
|
87 | 2. Call the app via apeman app command.
|
88 |
|
89 | **Apemanfile.js**
|
90 | ```javascript
|
91 | /** This example Apemanfile to use apeman-app-dynamic */
|
92 |
|
93 | "use strict";
|
94 |
|
95 | module.exports = {
|
96 | $pkg: {/*...*/},
|
97 | $apps: {
|
98 | // Define your own app.
|
99 | 'my-app-01': {
|
100 | // Map url and handlers.
|
101 | '/': [
|
102 | require('apeman-app-dynamic')({
|
103 | form: {/*...*/}, // Options for apeman-app-form
|
104 | query: {/*...*/}, // Options for apeman-app-query
|
105 | lang: {/*...*/}, // Options for apeman-app-lang
|
106 | header: {/*...*/}, // Options for apeman-app-header
|
107 | json: {/*...*/}, // Options for apeman-app-json
|
108 | html: {/*...*/} // Options for apeman-app-html
|
109 | }),
|
110 | function (req, res, next) {
|
111 | console.log(req.query);
|
112 | console.log(req.body);
|
113 | res.json({
|
114 | success: true
|
115 | });
|
116 | }
|
117 | ]
|
118 | }
|
119 | }
|
120 | };
|
121 | ```
|
122 |
|
123 | Then,
|
124 | ```bash
|
125 | $ apeman app my-app-01 -p 3000
|
126 | ```
|
127 |
|
128 |
|
129 |
|
130 |
|
131 |
|
132 |
|
133 | <a name="section-doc-readme-03-options-md"></a>
|
134 | Options
|
135 | -------
|
136 |
|
137 | | Key | Type | Default | Description |
|
138 | | --- | ---- | --- | --- |
|
139 | | form | object | {} | Options for [apeman-app-form](https://github.com/apeman-app-labo/apeman-app-form#readme)
|
140 | | query | object | {} | Options for [apeman-app-query](https://github.com/apeman-app-labo/apeman-app-query#readme)
|
141 | | header | object | {} | Options for [apeman-app-header](https://github.com/apeman-app-labo/apeman-app-header#readme)
|
142 | | lang | object | {} | Options for [apeman-app-lang](https://github.com/apeman-app-labo/apeman-app-lang#readme)
|
143 | | location | object | {} | Options for [apeman-app-location](https://github.com/apeman-app-labo/apeman-app-location#readme)
|
144 | | redirect | object | {} | Options for [apeman-app-redirect](https://github.com/apeman-app-labo/apeman-app-redirect#readme)
|
145 | | json | object | {} | Options for [apeman-app-json](https://github.com/apeman-app-labo/apeman-app-json#readme)
|
146 | | html | object | {} | Options for [apeman-app-html](https://github.com/apeman-app-labo/apeman-app-html#readme)
|
147 |
|
148 |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 |
|
154 |
|
155 |
|
156 | <a name="license"></a>
|
157 |
|
158 | License
|
159 | -------
|
160 | This software is released under the [MIT License](https://github.com/apeman-app-labo/apeman-app-dynamic/blob/master/LICENSE).
|
161 |
|
162 |
|
163 |
|
164 |
|
165 |
|
166 | <a name="links"></a>
|
167 |
|
168 | Links
|
169 | ------
|
170 |
|
171 | + [apeman](https://github.com/apeman-labo/apeman)
|
172 | + [apeman-app](https://github.com/apeman-labo/apeman-app)
|
173 | + [apeman-app-form](https://github.com/apeman-app-labo/apeman-app-form)
|
174 | + [apeman-app-query](https://github.com/apeman-app-labo/apeman-app-query)
|
175 | + [apeman-app-lang](https://github.com/apeman-app-labo/apeman-app-lang)
|
176 | + [apeman-app-location](https://github.com/apeman-app-labo/apeman-app-location)
|
177 | + [apeman-app-redirect](https://github.com/apeman-app-labo/apeman-app-redirect)
|
178 | + [apeman-app-header](https://github.com/apeman-app-labo/apeman-app-header)
|
179 | + [apeman-app-json](https://github.com/apeman-app-labo/apeman-app-json)
|
180 | + [apeman-app-html](https://github.com/apeman-app-labo/apeman-app-html)
|
181 |
|
182 |
|