KambojaJs

KambojaJS aims to fix some difficulties when using the old powerful guy, and increase testability, add convention over configuration and use modern language feature like async/await decorator etc, read more http://kambojajs.com/

Convention Over Configuration

KambojaJS route generation system generate url using pattern below:

<namespace>/<controller>/<action>?<parameter1>=value&<parameter2>=value 

Example you define controller like below

import { Controller } from "kamboja"

export namespace Api.v01
  export class UserController extends Controller {
    list(query:string, offset:number, limit:number){ }
  }
}

Above code by default will generate a GET url below

/api/v01/user/list?query=<value>&offset=<value>&limit=<value>

Refer to controller reference for more information

RESTful API support

For more advanced use, KambojaJS provide a convention for creating Restful API by using ApiController

Example controller below will create Restful API url for you

import { ApiController } from "kamboja"

namespace Api.V1 {
    export class ItemsController extends ApiController {
        //GET /api/v1/items/:id
        get(id:string) { }
        //GET /api/v1/items?offset=1&limit=<optional>
        list(offset:number, limit=50){ }
        //POST /api/v1/items
        add(data){ }
        //DELETE /api/v1/items/:id
        delete(id:string){ }
        //PUT /api/v1/items/:id
        replace(id:string, data){ }
        //PATCH /api/v1/items/:id
        modify(id:string, data){}
    }
}

Above code will generate some urls:

GET     /api/v1/items/:id
GET     /api/v1/items?offset=1&limit=<optional>
POST    /api/v1/items
DELETE  /api/v1/items/:id
PUT     /api/v1/items/:id
PATCH   /api/v1/items/:id

Refer to ApiController for more information

Examples

KambojaJS has several example for you to start with, from a simple Hello world to a complex restful api using dependency injection, check it out https://github.com/kambojajs/kamboja-examples/tree/master/packages

Contributing, Local Environtment Setup

KambojaJS using Lerna as package management and gulp as the custom build, you need to install them globally.

$ npm install -g lerna gulp

Clone the repository

$ git clone https://github.com/kambojajs/kamboja.git

Move to Kamboja directory

$ cd kamboja

Install root dependency

$ npm install

Bootstrap packages using lerna

$ lerna bootstrap

Compile/Run unit tests

$ gulp