Opinionated and minimalist MVC generator for koa. Inspired by express-generator.
The quickest way to get started with a koa app is to utilize the executable koa-mvc
to generate an application as shown below:
Create the app:
npm install -g koa-mvc koa-mvc /projects/foo && cd /projects/foo
Install dependencies:
Rock and Roll
node --harmony --harmony_proxies app
-t, --theme [name]
switch application theme to [white|green|violet|red]. Defaults to red.
-d, --db [engine]
change database to one of [mysql|postgresql|mongo|redis|memory|disk]. Defaults to disk.
-c, --css [engine]
add stylesheet support [less|stylus|plain]. Defaults to plain css.
-a, --auth [type]
add [type] authentication support [facebook|google|github|bitbucket|local]. Defaults to local only. Use ":" as separator for multiples (f.x. local:facebook:google). Set to false
to disable (like koa-mvc ... -a false
).
-e, --template [engine]
change template engine. Support [ejs] only for now. Defaults to ejs.
-i, --i18n
add i18n support. Translations used by i18n-node-2 ported to koa-i18n
-S, --no-session
remove session support. Session is enabled by default.
-f, --force
force on non-empty directory
Example using layout green, mysql as db, facebook and google authentication:
koa-mvc ~/www/test-koa-mvc -t green --db mysql -a local:facebook:google cd ~/www/test-koa-mvc npm install node --harmony --harmony_proxies app
Go to http://localhost:3000 and have fun hacking
Enough talk, show me somethinggreen with facebook authkoa-mvc myapp -t green -a facebook:github:google
:
configs
routes, general app stuff, authorizationmain
application configurationauth
authorization and authentication configdatabase
load models and initialize the database hereroutes
load controllers and define the routescontrollers
plain objects to use its methods as routessite
auth
authentication and authorization methodslocales
if i18n option is setmodels
uses Waterline ORMviews
templateserror
error views (401,403,404,error)layouts
layouts folder (main, error)site
application views (index, login)web
public foldercss
js
Also
Optional
Also
Koa currently requires node 0.11.x for the --harmony --harmony_proxies flags which exposes generators and proxies to your script. If you're running an earlier version of node you may install n, a node version manager to quickly install 0.11.x:
$ npm install -g n
$ n 0.11.13
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4