wyntau/kman

Koa + MongoDB + Angular.js + Node.js. A starting point for writing AngularJS apps backed by a Koa-powered node.js server.

KMAN

Koa + MongoDB + Angular.js + Node.js

A starting point for writing AngularJS apps backed by a Koa-powered node.js server.

KMAN based on koan, but have some differences with koan.

• use high level mongoose
• use high level socket.io (Experimental, not sure how to use it correctly)
• use SASS
• more pre-defined grunt tasks for development(watch, livereload) and deploy(compile, build, concat, uglify, compress, md5, etc.)

Requirements

1. MongoDB
2. node >= 0.11.9
3. ruby and sass,compass gems
4. git

In addition, Linux or Mac is optional but recommended, because Linux or Mac is more friendly to ruby(& gems) and some npm packages.

For Developers

1. Develop

    npm install -g bower grunt-cli
    npm install
    bower install
    grunt dev
   

   Then the default browser will open http://localhost:3000 automatically.

   A livereload server was started by grunt-contrib-watch which will watch static files(css, sass, js, html) and server(via nodemon).

   So, if you want to refresh your browser when you changed specific files, maybe you should install the browser extension.

2. Build

    grunt build
   

   kman-v{VERSION}.zip will be in zips directory.

3. Test

   • Front-end e2e test. (Note: Before this test, the app server should be running, you can open another terminal, and run node --harmony app.js)

       grunt client_e2e
     

   • Front-end unit test

       grunt client_unit
     

   • Server test

     Upcoming

For Deploy

npm install --production
npm start

You can see nginx/kman.conf for nginx setting for http://kmanjs.com

LICENSE

MIT

kman's Issues

update README for usage

• how to define a resource api
• how to define a normal api
• how to define a normal path

move resources and apis to one directory

move all resources and apis to only one directory, so we can use only /api prefix. just like what https://github.com/koajs/api-boilerplate/blob/master/lib/load/index.js do

we can add just js files or sub-directories in api.

if js files and end with .resource.js or .restful.js, we will treat it as one resource.
if js files just end with .js, we will treat it as normal path api.

In sub-directory, one config.js or config.json should tell which type api it is.

execute prepare before start koa

use server/prepare to load some prepares before the server start, so we can do some special thing

use pure exports when define one resource

Now to define one resource, we have to use one resource function, we can do some works to use pure exports to define resources

index.html 里的common.use.notifications，这个在哪里定义？

还是ng-href=/notifications/ 的路由；也没有相关处理...

add server test

now only client tests(unit, e2e) are included, server tests should added using test mongo database.